代码评审技术

代码评审技术

代码审查（Code Review）是一种用来确认方案设计和代码实现的质量保证机制，它通过阅读代码来检查源代码与编码规范的符合性以及代码的质量。

代码审查的作用

• 检查设计的合理性
• 互为 Backup
• 分享知识、设计、技术
• 增加代码可读性
• 处理代码中的“地雷区”

缺陷检查表

Python代码分析工具

Pylint 是一个 Python 代码分析工具，它用于分析 Python 代码的错误，查找不符合代码风格标准（Pylint 默认使用的代码风格是 PEP 8）和有潜在问题的代码。

Pylint功能

• 检查代码风格是否符合PEP8规范
• 检查代码是否存在常见的错误和违反最佳实践
• 检查重复的代码

Pylint 安装与使用

Pylint 安装：

pip install -U pylint # 安装最新版的Pylint

Pylint 使用：

pylint    [op0ons]    module_or_package_or_file # 对模块/包/文件运行pylint

--rcfile= 指定检查的配置文件
--ignore= 不进行检查的文件列表
--disable= 关闭某种类型的检查
-f 报告类型, 如html

代码静态分析工具

• • Checkstyle：通过对代码编码格式、命名约定、Javadoc、类设计等方面进行代码规范和风格的检查。
  • FindBugs：通过检查类文件或JAR文件，将字节码与一组缺陷模式进行对比从而发现代码缺陷，完成静态代码分析。
  • PMD：通过其内置的编码规则对Java代码进行静态检查，主要包括对潜在的Bug、未使用的代码、重复的代码、循环体创建新对象等问题的检验。

  • Jtest：能够按照其内置的超过800条的Java编码规范自动检查并纠正这些隐蔽且难以修复的编码错误，同时还支持用户自定义编码规则，帮助用户预防一些特殊用法的错误。

• 微软Visual Studio中的代码分析工具可以检查代码中是否存在一些常见缺陷和违反良好编程习惯的情况。

• 微软Visual Studio中的代码分析工具可以检查代码中是否存在一些常见缺陷和违反良好编程习惯的情况。
• JSHint（www.jshint.com）是一款JavaScript代码验证工具，用于检测代码中的错误和潜在问题。
• CSSLint（csslint.net）是一款CSS代码检查工具，可以进行基本语法检查以及使用一套预设的规则来检查代码中的问题。
• HTMLHint（htmlhint.com）是一款基于JS开发的静态扫描组件，支持所有浏览器和Nodejs平台，可集成到IDE环境或编译系统中。