代码评审 Code Review
介绍几个轻量级代码检查工具,包括代码静态检查,整理代码等。
无论是自己一个人写代码,还是与其他人合作写代码,都希望能有一份高质量的代码,以便别人或未来的自己可读、可维护和可扩展。
于是往往我们需要代码评审(Code Review)。正式的代码评审已经有不少书籍介绍且与开发环境有关,这里只介绍几个轻量级代码检查工具,方便日常开发过程中提高自己的代码质量。
Python
Pylint
Pylint 是一个 Python 源代码分析工具,可以分析代码错误,查找不符合代码风格标准(Pylint 默认使用的代码风格是 PEP 8)和有潜在问题的代码。
安装:
1 | pip install pylint |
使用:
1 | pylint 1.py |
安装直接用 pip 就可以了,使用则是输入代码文件路径就可以了,它会输出存在不同级别问题的代码的所在位置,还能评分。更多的用法可以参考官方网站。
yapf
https://github.com/google/yapf
yapf 是一个 Google 开源的 Python 代码格式化工具。可以格式化代码,统一缩进、换行、符号等格式。
安装:
1 | pip install yapf |
使用:
1 | yapf 1.py > out.py |
安装直接用 pip 就可以了,使用则是输入代码文件路径就可以了,它会输出美化后的代码,因此可以重定向至一个文件。更多的用法可以参考官方网站。
C++
cpplint
https://github.com/cpplint/cpplint
cpplint 是一个遵循 Google C++ 风格指南的 C++ 静态代码检索工具。
安装:
1 | pip install cpplint |
使用:
1 | cpplint 1.cpp |
安装直接用 pip 就可以了,使用则是输入代码文件路径就可以了,它会输出存在不同级别问题的代码的所在位置。更多的用法可以参考官方网站。
AStyle
http://astyle.sourceforge.net/
AStyle 即 Artistic Style,是一个支持 C, C++, C++/CLI,Objective‑C, C# 和 Java 的格式化工具。可以格式化代码,统一缩进、换行、符号等格式。
注意 AStyle 风格与 Google C++ 风格不一样。
安装:
到 https://sourceforge.net/projects/astyle/ 点“Download”按钮即可根据当前平台下载相应安装包,根据说明安装即可。
使用:
1 | astyle 1.cpp |
使用则是输入代码文件路径就可以了,它会输出美化后的代码,并把原代码备份至 1.cpp.orig
。更多的用法可以参考官方网站。
Sublime 插件
以上工具均在 Sublime 中能找到插件,只需 Install Package 安装即可。之后可在编码时实现一键格式化或一键检查。
SublimeLinter 里包含各种语言的 linter。
PyYapf 是 Python yapf 格式化工具。
SublimeAStyleFomatter 是 C++ AStyle 格式化工具。