Internal documentation: Difference between revisions
Eleven even (talk | contribs) m Reverted edits by 72.91.247.20 (talk) to last version by Graham87 |
No edit summary |
||
| Line 6: | Line 6: | ||
[[Category:Technical communication]] |
[[Category:Technical communication]] |
||
Internal Documentation is also used for term papers and reports. For example, if you have a book written by Charles Henderson and you know the page number of the information you acquired, you can simply insert in parantheses after your sentence (Henderson 98) if the inforcmation was on page 98) |
|||
Revision as of 00:23, 5 January 2009
Computer software is said to have Internal Documentation if the notes on how and why various parts of code operate is included within the source code as comments. It is often combined with meaningful variable names with the intention of providing potential future programmers a means of understanding the workings of the code.
This contrasts with external documentation, where programmers keep their notes and explanations in a separate document.
Internal documentation has become increasingly popular as it cannot be lost, and any programmer working on the code is immediately made aware of its existence and has it readily available.
Internal Documentation is also used for term papers and reports. For example, if you have a book written by Charles Henderson and you know the page number of the information you acquired, you can simply insert in parantheses after your sentence (Henderson 98) if the inforcmation was on page 98)