| 词条 | 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.[1] In web development, self-documenting refers to a website that exposes the entire process of its creation through public documentation, and whose public documentation is part of the development process.{{Citation needed|date=August 2018}} Objectives{{Unreferenced section|date=June 2015}}Commonly stated objectives for self-documenting systems include:
Conventions{{Unreferenced section|date=June 2015}}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 numberOfWordsInThisArticle 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{{Unreferenced section|date=June 2015}}There are certain practical considerations that influence whether and how well the objectives for a self-documenting system can be realized.
See also
References1. ^{{Cite book| first = Stephen R.| last = Schach| title = Object-Oriented and Classical Software Engineering| edition = 8th| publisher = McGraw-Hill Professional| year = 2011| pages = 505–507| isbn = 9780073376189| oclc = 477254661}} External links
2 : Computer programming|Software documentation |
| 随便看 |
|
开放百科全书收录14589846条英语、德语、日语等多语种百科知识，基本涵盖了大多数领域的百科知识，是一部内容自由、开放的电子版国际百科全书。