Which of the following statements about API documentation are true? API document
ID: 3918867 • Letter: W
Question
Which of the following statements about API documentation are true?
API documentation is largely unnecessary if the code has been designed to be self-documentating.
API documentation focuses on how software is used rather than on how it works.
API documentation has supplanted inline commenting as the primary form of source code documentation.
API documentation clarifies the choice of implementing data structures and algorithms for a class.
API documentation tools are not widely available for many popular programming languages.
API documentation is largely unnecessary if the code has been designed to be self-documentating.
API documentation focuses on how software is used rather than on how it works.
API documentation has supplanted inline commenting as the primary form of source code documentation.
API documentation clarifies the choice of implementing data structures and algorithms for a class.
API documentation tools are not widely available for many popular programming languages.
Explanation / Answer
In my opinion, any code should be self-documenting. In good, self-documented code, you don't have to explain every single line because every identifier (variable, method, class) has a clear semantic name. Having more comments than necessary actually makes it harder (!) to read the code, so if your colleague
Related Questions
drjack9650@gmail.com
Navigate
Integrity-first tutoring: explanations and feedback only — we do not complete graded work. Learn more.