用Python检查代码中的TODO、FIXME、XXX

我们写代码时，常常会写一个TODO的注释来表明这里还需要添加或完善功能（先集中精力完成重要的功能）。或者用FIXME来表明这里有一些小BUG（但现在不影响主要功能）。也可能会用XXX来表明这里还有改进的空间（但现在还不是时候）。这些额外注释的确是写code的小助手。但如果在Tapeout前忘了（或者漏掉）要完善或改进一些细节，倒有些可惜。代码太多、太长，谁记得有没有加过FIXME？！

今天我们来用Python写一段脚本检查代码中是不是有被遗忘的特殊注释。

需求分析

1. 可以指定要检查代码的目录

2. 只检查目录里的.v和.sv的文件，忽略其它文件

3. 支持TODO，FIXME，XXX三种特殊注释

4. 报错时显示文件与行号，方便后续修改

实现过程

通过命令行参数指定代码目录，如下：

把文件路径传递给检查函数，打开文件，逐行检查有无TODO、FIXME、XXX等特殊注释。如果有，则报错Error: +lineno file，并打印出错行。

最终效果

最终效果如下：

欢迎关注ExASIC

分享数字集成电路设计中的经验和方法

分享让工作更轻松