Self-documenting definition of Self-documenting in the Free Online Encyclopedia.

self-documenting code

Programming statements that can be easily understood by the author or another programmer. Some languages are inherently more self documenting than others. For example, to the novice, COBOL provides more self-documenting code than C.

It's Very Subjective
However, what one programmer thinks is self documenting may truly be indecipherable to another. For example, today's operating systems offer hundreds of programming interfaces (APIs) that the application may call. If programmers are familiar with those calls, they may feel that English commentary is unnecessary, because the API uses a logical name and is well documented by the OS vendor. However, in order to understand the code, a third party not familiar with the calls has to keep flipping back and forth from the application source code to the OS documentation, presuming it is readily available in the first place. A well-written line of English for each of these calls would be far more helpful.

Programmers tend to dislike documentation, and that is an understatement. Many simply do the barest minimum unless carefully supervised. Some do none at all if they can get away with it. See documentation.

self-documenting code [¦self ‚däk·yə‚ment·iŋ ′kōd]

(computer science)

A sequence of programming statements that are simple and straightforward and can be readily implemented by another programmer.

Mentioned in	?		References in periodicals archive	?		Encyclopedia browser	?		Full browser	?
No references found	Asset management software, along with a self-documenting calibrator, provides a fully automated calibration process. Microbial maintenance by David Hillyer and James Cox / InTech Some of its features include self-documenting context menus that perform calculations and provide a description of the steps, enhanced plotting capabilities and a strong mathematical computation engine. Maple 11: Maplesoft by District Administration Additional features include an intuitive, flowchart-based application development environment; application deployment scalable from one to hundreds of telephone lines on a single TeleFlow server; self-documenting applications; application testing and demonstration with TeleFlow Simulator; remote monitoring and administration; DLL plug-ins and compilable environment; passive call recording and call monitoring. enGenic releases TeleFlow 2004 suite by Customer Interaction Solutions	Self-Consciousness Self-Consistent Field self-consistent field method self-contained base-line system self-contained breathing apparatus self-contained database management system Self-Contained Electrical Power Supply self-contained night attack self-contained portable electric lamp self-contained range finder self-coved self-defence self-defense Self-Defense Force self-defocusing self-destroying self-destroying fuse self-destruct charge self-destructing e-mail self-destruction self-destruction equipment self-determination self-diagnostic routine self-differentiation Self-Diffusion Self-documenting self-documenting code self-dual switching function self-dumping cage self-dumping car Self-Education self-employed self-energizing brake self-energy self-esteem Self-Evaluation Self-Excitation of Generators Self-Excitation of Oscillations self-excited self-excited oscillator self-excited vibration Self-Extensible Language self-extinguishing self-extracting archive self-extracting exe self-extracting file self-faced stone Self-Fertilization self-fields Self-Financing self-finished roofing felt	Self-Directed Registered Retirement Savings Plan Self-Directed Registered Retirement Savings Plans Self-Directed Retirement Account Self-directed retirement plan Self-directed retirement plan Self-Directed Retirement Plans Self-Directed Retirement Savings Plan Self-Directed Risk Management Self-Directed RRSP Self-Directed RRSPs Self-Directed Work Team self-directing self-directing self-direction self-direction self-direction of care Self-Discharge Count Register self-discipline self-discipline self-discipline self-disciplined self-disciplined Self-disclosure self-discoveries self-discovery self-disgust Self-Disparagement self-dissociation self-distrust self-distrustful Self-documenting Self-documenting code self-doubt self-doubt self-doubting self-doubting Self-Drilling, Self-Tapping self-drive self-drive hire Self-Driven Particle Model Self-driving car Self-driving car Self-Dual Additive Code Self-Dual Binary Self-dual code self-dual switching function self-dumping cage self-dumping car self-educated self-educated self-education self-education self-effacement self-effacement self-effacement self-effacing self-effacing self-effacing self-effacingly self-effacingly Self-efficacy

Mentioned in

References in periodicals archive

Encyclopedia browser

Full browser

No references found

Asset management software, along with a self-documenting calibrator, provides a fully automated calibration process.

Microbial maintenance by David Hillyer and James Cox / InTech

Some of its features include self-documenting context menus that perform calculations and provide a description of the steps, enhanced plotting capabilities and a strong mathematical computation engine.

Maple 11: Maplesoft by District Administration

Additional features include an intuitive, flowchart-based application development environment; application deployment scalable from one to hundreds of telephone lines on a single TeleFlow server; self-documenting applications; application testing and demonstration with TeleFlow Simulator; remote monitoring and administration; DLL plug-ins and compilable environment; passive call recording and call monitoring.

enGenic releases TeleFlow 2004 suite by Customer Interaction Solutions

Self-Consciousness

Self-Consistent Field

self-consistent field method

self-contained base-line system

self-contained breathing apparatus

self-contained database management system

Self-Contained Electrical Power Supply

self-contained night attack

self-contained portable electric lamp

self-contained range finder

self-coved