Konubinix' opinionated web of thoughts

Self-Documenting Code


Commonly stated objectives for self-documenting systems include:

  • Make source code easier to read and understand[2]
  • Minimize the effort required to maintain or extend legacy systems[2]
  • Reduce the need for users and developers of a system to consult secondary documentation sources such as code comments or software manuals[2]
  • Facilitate automation through self-contained knowledge representation