-
Book Overview & Buying
-
Table Of Contents
Hands-On Software Engineering with Python - Second Edition
By :
Before deciding how, when, and where to document code, there is another question that needs to be considered: what purpose (or purposes) does code documentation serve? The initial If I were a new member of the team… question that this chapter started with reflects one of several possible purposes being served by documentation: Making sure that team members have enough information to do their job without having to track down answers elsewhere. A similar variant might be phrased as follows:
If I were a developer using this code for the very first time, is there enough information available that I can use it with a minimum of time spent understanding what I need to do?
The difference between these is, ultimately, a difference in expectations of who will be using the code, and what shape that use takes. The team-member will have direct access to the code in question, and the information available therein. The external developer will also have...