Created: 2023-01-11 10:43
Status: #concept
Subject: Programming
Tags: C Comments
Documentation
It is identifying information for the program and includes a high-level description of the functionalities of the program.
Here are some things programmers place in their documentation.
- program name
- date written
- author
- the purpose of the program
- etc.
There are also DevOps software that make writing documentation easier (see Doxygen).
References
- C Programming, A Modern Approach, 2nd Edition, Chapter 2.3