Atlas48/JargonFile
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Self-documenting code

Browse Source
This commit is contained in:
Bob Mottram 2015-04-06 17:13:54 +01:00
parent 7f675b4421
commit bb884ae993
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
entries/self-documenting-code.txt Normal file
View File

@ -0,0 +1,10 @@
self-documenting code
The belief that with meaningful variable name choices and uncompromising
adherence to a coding style the need for comments written in natural
language (typically English) can be reduced towards zero. This belief
is in almost all cases false. Hackers are often under the impression
that what their code does is somehow immediately "obvious" to the
reader, but this is only the case if others think about the algorithmic
structure of problems in an identical manner, which in practice almost
never happens. Also see literate programming.