Internal documentation

Internal documentation

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.


Wikimedia Foundation. 2010.

Игры ⚽ Поможем сделать НИР

Look at other dictionaries:

  • Internal control — In accounting and organizational theory, Internal control is defined as a process effected by an organization s structure, work and authority flows, people and management information systems, designed to help the organization accomplish specific… …   Wikipedia

  • Comparison of documentation generators — The following tables compare general and technical information for a number of documentation generators. Please see the individual products articles for further information. This article is not all inclusive or necessarily up to date. Unless… …   Wikipedia

  • ISA 230 Documentation — is one of the International Standards on Auditing. It serves to direct the documentation of audit working papers in order to assist the audit planning and performance; the supervision and review of the audit work; and the recording of audit… …   Wikipedia

  • Language documentation — is the process by which a language is documented from a documentary linguistics perspective. It aims to “to provide a comprehensive record of the linguistic practices characteristic of a given speech community” (Himmelmann 1998:166, see also… …   Wikipedia

  • Software development process — Activities and steps Requirements Specification …   Wikipedia

  • ETA — Infobox militant organization name = Euskadi Ta Askatasuna, (ETA) caption = ETA symbol dates = 1959–present leader = Mikel Garikoitz Aspiazu Rubina Txeroki Fact|date=February 2008 motives = The creation of an independent socialist Basque Country… …   Wikipedia

  • HP-41 — The HP 41 series are programmable, expandable, handheld RPN calculators made by Hewlett Packard from 1979 to 1990. The original model, HP 41C, was the first of its kind to offer alphanumeric display capabilities. Later came the HP 41CV and HP… …   Wikipedia

  • Medici bank — Infobox Defunct Company company name = Medici bank company fate = Shut down by authorities successor = foundation = c. 1397 defunct = 1494 location = Various; home branch in Florence, Italy industry = Banking key people = Giovanni di Bicci,… …   Wikipedia

  • Medici Bank — For the private bank in Austria that failed due to its investment in Bernard Madoff s Ponzi scheme, see Bank Medici. Medici Bank Industry Banking Key people Giovanni di Bicci, Cosimo de Medici, Piero di Cosimo, Lorenzo de Medici, Francesco… …   Wikipedia

  • Wiki — This article is about the type of website. For other uses, see Wiki (disambiguation). Edit summary redirects here, for edit summaries as used in Wikipedia see Help:Edit summary WikiNode redirects here, for the WikiNode of Wikipedia see… …   Wikipedia

Share the article and excerpts

Direct link
Do a right-click on the link above
and select “Copy Link”