[构思]依据verilog源文件中的关键代码及其注释，使用脚本命令生成代码文档

依据verilog源文件中的关键代码及其注释，使用脚本命令生成代码文档。（跟Doxygen工具功能类似）

针对的场景是工程里的代码没有文档，阅读不方便。注释没有章法，代码越长，阅读直观感受越差。

脚本需求指数，个人认为二颗星吧（毕竟还没见到周围人写过代码文档）。脚本实现后，应该可以规范代码文档的格式，方便了解代码文档的质量。

Doxygen_百度搜索
https://www.baidu.com/s?f=8&rsv_bp=1&rsv_idx=1&word=Doxygen&tn=97925205_hao_pg

verilog代码文档的内容需求

verilog代码文档的内容需求，一般包括下述方面：

• module功能。需要verilog注释加以描述。
• 端口介绍。需要verilog注释加以描述。
• 基本算法（比如状态机的状态跳转，为了方便。可以利用simvision里的状态跳变图）。需要verilog注释配合加以描述。
• 实现框架（主要是介绍内部实例之间的关系。可以利用simvision里的schematic视图。可以visio）。需要verilog注释加以描述。
• author、date、修改history等代码版本相关的信息，可以通过svn/git去维护。不需要verilog注释加以描述。
• define、parameter、localparam描述。需要verilog注释加以描述。
• 内部变量描述，wire和reg。需要verilog注释加以描述。
• 每个代码段的简单描述。需要verilog注释加以描述。

生成文档的实现思路

意义：
1. 文档和代码保持一致。
2. 方便养成代码写注释和写文档的习惯。
3. 方便code review。

实现思路：
1. 脚本实现用perl即可。
2. verilog注释，依赖的是关键词“//”和“/**/”。
3. verilog代码文档，很多信息，来源于代码本身。所以，不要局限于注释内容。
4. verilog代码为了保证清晰明了，使用图形在所难免。所以利用markdown语法即可，但是markdown语法版本太多，怎么选择？

综上所述，脚本实现不难，而且有一定的工程意义。