Self-documenting code

In computer programming, self-documenting (or self-describing) source code and user interfaces follow naming conventions and structured programming conventions that enable use of the system without prior specific knowledge. == Objectives == Commonly stated objectives for self-documenting systems include: Make source code easier to read and understand Minimize the effort required to maintain or extend legacy systems Reduce the need for users and developers of a system to consult secondary documentation sources such as code comments or software manuals Facilitate automation through self-contained knowledge representation == Conventions == Self-documenting code is ostensibly written using human-readable names, typically consisting of a phrase in a human language which reflects the symbol's meaning, such as article.numberOfWords or TryOpen.

Source: Wikipedia — Self-documenting code (CC BY-SA 4.0)

Self-documenting code

In computer programming, self-documenting (or self-describing) source code and user interfaces follow naming conventions and structured programming conventions that enable use of the system without prior specific knowledge. == Objectives == Commonly stated objectives for self-documenting systems include: Make source code easier to read and understand Minimize the effort required to maintain or extend legacy systems Reduce the need for users and developers of a system to consult secondary documentation sources such as code comments or software manuals Facilitate automation through self-contained knowledge representation == Conventions == Self-documenting code is ostensibly written using human-readable names, typically consisting of a phrase in a human language which reflects the symbol's meaning, such as article.numberOfWords or TryOpen.

Source: Wikipedia "Self-documenting code" · CC BY-SA 4.0

Share this article: X · Bluesky
Privacy Policy