天天看点

《嵌入式C编程:PIC单片机和C编程技术与应用》一2.5 设计文档

当程序中用到一些标识符(像max_number_of_entries),并且需要一份正式文档时,该文档需要列出所有的常量,并说明它们的含义。在程序中添加注释来描述这些常量将有助于理解代码,并有助于生成文档。

有些工具可以从代码中提取出常量的注释,下面给出了常量注释的例子:

《嵌入式C编程:PIC单片机和C编程技术与应用》一2.5 设计文档

继续阅读