Internal documentation

Question 1

Explain the purpose of internal documentation.

Answer 1

Internal documentation covers the entire program, detailing classes, functions, methods, objects, and algorithms. It combines with well-named variables for organized and effective code.

Question 2

What are three conventions of internal documentation that should be included
in source code?

Answer 2

• Descriptions of how to test aspects of the software.
• Multi-line comments, explaining a complex algorithm within the code itself.
• Single line comments, providing brief summaries of portions of code.

Question 3

Does internal documentation slow down a software solution? Explain.

Answer 3

No, comments in code are ignored by the compiler.