{
  "id": "enwiki-001299078526",
  "slug": "self-documenting-code",
  "title": "Self-documenting code",
  "qid": "",
  "lead": "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.",
  "body": "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. The code must also have a clear and clean structure so that a human reader can easily understand the algorithm used. ==Practical considerations== There are certain practical considerations that influence whether and how well the objectives for a self-documenting system can be realized. uniformity of naming conventions consistency scope of the application and system requirements ==Examples== Below is a very simple example of self-documenting C code, using naming conventions in place of explicit comments to make the logic of the code more obvious to human readers. size_t count_alphabetic_chars(const char *text) { if (text == NULL) return 0; size_t count = 0; while (*text != '\\0') { if (is_alphabetic(*text)) count++; text++; } return count; } ==See also== Autological word Code readability Comment (computer programming) Controlled natural language Literate programming Natural language programming ==References== ==Further reading==",
  "categories": [
    "22903783",
    "22914101",
    "23118434",
    "23468805",
    "23603337",
    "24043274",
    "27179392",
    "28699009",
    "85562283"
  ],
  "license": "CC BY-SA 4.0",
  "source_uri": "https://en.wikipedia.org/w/index.php?oldid=1299078526",
  "content_hash": "",
  "created_at": null,
  "updated_at": 1751797157.0,
  "claims": [],
  "contradictions": [],
  "confidence": 0.6,
  "csl": {
    "id": "enwiki-001299078526",
    "type": "webpage",
    "title": "Self-documenting code",
    "author": [
      {
        "family": "Anticloud FZ LLE",
        "literal": "Anticloud FZ LLE"
      }
    ],
    "container-title": "encyclopegia.org",
    "publisher": "Anticloud FZ LLE",
    "publisher-place": "Dubai, United Arab Emirates",
    "URL": "https://encyclopegia.org/a/self-documenting-code",
    "issued": {
      "date-parts": [
        [
          2026,
          11,
          16
        ]
      ]
    },
    "accessed": {
      "date-parts": [
        [
          2026,
          11,
          16
        ]
      ]
    },
    "license": "CC BY-SA 4.0",
    "DOI": "eo1:enwiki-001299078526",
    "isBasedOn": "https://en.wikipedia.org/w/index.php?oldid=1299078526",
    "note": "Immutable snapshot enwiki-001299078526"
  }
}