最近公司项目开始统计代码注释率,毕竟完全可读的代码是不存在的,提高代码可读性最好的方式还是多写注释,这样也可以帮助后来接手的同事更快的熟悉业务逻辑。
目前项目中的注释统计工具是cloc,戳这里可以直接去它的github首页。
首页说明中可以看到该工具目前可以在各大主流的插件市场下载到,我的机器是mac,所以直接使用homebrew来安装这个工具。打开终端terminal,输入“brew install cloc”即可安装该工具。安装完成后cd进入我们需要统计代码文件夹路径下,最后使用"cloc ./"命令即可统计该文件夹下文件中的注释行数和代码行数,进而得出注释率。
bingo!