3 ms·
In Chapter 15 - 'The Other Face' - in the "The Mythical Man-Month" by Fred Brooks, there is a section on "Self-Documenting Programs." There is a code example th
by dpflan 12y ago
In Chapter 15 - 'The Other Face' - in the "The Mythical Man-Month" by Fred Brooks, there is a section on "Self-Documenting Programs." There is a code example that has more documentation and comments than code - it looks exceptionally thorough. In addition, Brooks lists an approach and some techniques for documenting a program.
One may even consider tests as part of documentation because they are functional representations of the logic you've developed - they can be the examples that can show how to and how not to use the program.
Here is a link to the mentioned chapter and figure (15.3 A self-documenting program) from "The Mythical Man-Month":
http://books.google.com/books?id=Yq35BY5Fk3gC&pg=PT162&lpg=PT162&dq=mythical+man+month+figure+15.3&source=bl&ots=2-elN6Vnmf&sig=5QDgYnBYI7z3lRKZxu-KywdfBKg&hl=en&sa=X&ei=drYyVIT7CJKYyASwi4LACQ&ved=0CCQQ6AEwAQ#v=onepage&q=mythical%20man%20month%20figure%2015.3&f=false http://books.google.com/books?id=Yq35BY5Fk3gC&pg=PT162&lpg=P...
- Please let me know if this link is failing, and I will try to find another source.