Last updated Unknown

Status: Tags: Links: Software Development Process

Code Documentation

C

placed in both .h and .cpp files

• Header comment block
• Class/file name
• Class description
• Class invariant (if any)
• Author
• Creation/modification date

For each public and private methods

• Description → single responsibility
• Precondition: What must be true before the method is called
• Postcondition: What is true after the method has executed

Backlinks

1

list from Code Documentation AND !outgoing(Code Documentation)

References:

Created:: 2022-01-17 17:38