本节书摘来自华章出版社《嵌入式C编程:PIC单片机和C编程技术与应用》一书中的第2章,第2.5节,作者 [美]马克·西格斯蒙德(Mark Siegesmund),更多章节内容可以访问云栖社区“华章计算机”公众号查看
2.5 设计文档
当程序中用到一些标识符(像MAX_NUMBER_OF_ENTRIES),并且需要一份正式文档时,该文档需要列出所有的常量,并说明它们的含义。在程序中添加注释来描述这些常量将有助于理解代码,并有助于生成文档。
有些工具可以从代码中提取出常量的注释,下面给出了常量注释的例子: