标签：异常 超过 理解 截图 链接 源代码 遇到 字符 mod
1） 了解代码审查的含义；
2） 掌握相关编程规范检查工具的安装与使用；
Code Review中文应该译作“代码审查”或是“代码评审”或“代码复查”，是指通过阅读代码来检查源代码与编码标准的符合性以及代码质量的活动。Code Review主要用来在软件工程过程中改进代码质量，通过代码评审可以达到如下目的：
●在项目早期就能够发现代码中的BUG
●帮助初级开发人员学习高级开发人员的经验，达到知识共享
●避免开发人员犯一些很常见，很普通的错误
●保证项目组人员的良好沟通
●项目或产品的代码更容易维护
代码评审主要内容是编程规范，重构方法，架构设计，性能安全，日志，可读性，扩展性等问题。通过代码评审可查找和修复引入到开发阶段的应用程序的错误，提高软件的整体素质和开发者的技能。代码评审的作用和意义已在很多技术团队内达成共识，可是很多时候并未被有效执行，甚至被认为是一项费时费力的工作。借助一些工具可以更容易，更有效率地来进行Code Review。
1、以小组形式，针对前面“实验一”中所完成的代码，进行代码评审(走查)，重点检查以下情况。你也可有查询相关材料，建立更细化的检查清单（check list）
- 程序是否能正常工作，代码是否实现预期的功能，逻辑是否正确。
- 代码是否遵循的编程规范
- 代码是否尽可能的模块化
- 所有的数据输入是否都进行了检查
- 是否有注释，并且描述了代码的意图
- 代码的可理解性和可测试性
2、按“实验二”的分组方式，两人一组，随机分配另一组的代码作为本组评审和分析的对象。一些编码规范的检查工具如下，也可自行查找工具使用。
（1） java语言
- 采用使用eclipse Checkstyle插件
- CheckStyle是SourceForge下的一个项目，提供了一个帮助JAVA开发人员遵守某些编码规范的工具。它能够自动化代码规范检查过程，从而使得开发人员从这项重要 但枯燥的任务中解脱出来。它可以根据设置好的编码规则来检查代码。比如符合规范的变量命名，方法体的最大行数，重复代码检查等等。
如果你使用idea ，可以使用Alibaba Java Code Guidelines插件，参考链接如下：https://github.com/alibaba/p3c/wiki/IDEA%E6%8F%92%E4%BB%B6%E4%BD%BF%E7%94%A8%E6%96%87%E6%A1%A3
（2）C++语言
- 可使用Google代码规范工具Cpplint。
- Cpplint是一个python脚本，Google使用它作为自己的C++代码规范检查工具，VSCcode可配置Cpplint对C++代码进行规范检查。
python
- 可采用pylint
- Pylint 是一个 Python 代码分析工具，它分析 Python 代码中的错误，查找不符合代码风格标准（Pylint 默认使用的代码风格是 PEP 8，具体信息，请参阅参考资料） 和有潜在问题的代码。目前在 eclipse 的 pydev 插件中也集成了 Pylint，VSCcode可安装pylint插件
当发现了项目存在的问题后，可通过Bug跟踪系统向项目维护者反馈问题（issue）,管理Issue的系统称为BTS（Bug Tracking System，Bug跟踪系统）。当今具有代表性的BTS有Redmine、Trac、BugZilla等。GitHub自身也加入了BTS的功能。在GitHub上，可以将它作为软件开发者之间的交流工具。通过github的issues功能开发者可以便捷的发现软件的BUG并报告，想向项目所有人询问或用来追踪各种想法探讨准备实施的任务。
（1）配置代码审查工具。要求采用屏幕截图的方式配置的过程；
（2）使用工具对原始代码进行评审和分析，记录结果，期间不要有任何修改；
（3）对工具执行结果进行人工分析，结合检查清单和人工走查的出代码修改建议；
（4）通过github issues向项目维护者提交问题(issue),注意一个issue 只报告一个问题，多个问题需放在多个issue中，以便跟踪。
（5）记录总结实验过程中遇到的问题和解决过程
四、实验记录
1、配置代码审查工具。要求采用屏幕截图的方式配置的过程；
将要审查的是Python代码，所以选择使用pylint进行代码审查。
（1）Pylint 在 Windows 上的安装
①方法1：在命令行，python目录下运行pip install python
②方法2：第一步：
Pylint要求安装astriod，logilab-common，setuptools等包，可以分别到相应的网址上去下载。
下载setuptools， 网址： https://pypi.python.org/pypi/setuptools/1.1.6
下载pylint，目前推荐下载1.3.1版本，网址： https://bitbucket.org/logilab/pylint
下载astriod，网址： https://bitbucket.org/logilab/astroid
下载logilab-common ，网址：http://www.logilab.org/848/
第二步：
安装 Python 的包（高于版本 2.2），右键单击桌面上的我的电脑图标，选择属性，高级，环境变量，在 $PATH 中添加 Python 的安装路径，如 C:\Python26\。
第三步：
使用解压缩工具解压缩所有的包。
第四步：
打开命令行窗口，使用 cd依次进入 logilab-astng、logilab-common 和 Pylint 解开的文件夹中，运行命令 python setup.py install来安装。
第五步：
安装完成后，在 Python 的安装路径下出现一个 Scripts 文件夹，里面包含一些 bat 脚本，如 pylint.bat 等。
第六步：
为了使调用 pylint.bat 的时候不需要输入完整路径，在 Python 的安装目录下创建 pylint.bat 的重定向文件，这是一个纯文本文件 pylint.bat，里面包含 pylint.bat 的实际路径，如：C:\Python26\Scripts\pylint.bat。
第七步：
安装完成后，可以通过 pylint [options] module_or_package来调用 Pylint 了。
（2）在pycharm上配置pylint
打开pycharm,File->settings
其中：
program：是python安装路径下的Scripts路径，我是F:\python\Scripts\pylint.exe
Arguments:--reports=n --disable=C0103 $FilePath$ （最后要以$FilePath$结尾）
working directory：$FileDir$
output filters：$FILE_PATH$:$LINE$:
配置完成后：
点击pylint即可对代码进行审查
2、代码审查
3.问题汇总
| 错误类型 | 问题标识 | 建议解决方法 | 出错处 |
|
C
|
line-too-long 语句过长 | 同一行的代码（包括注释）不宜超过100字符 | line58、line59 |
| bad-whitespace 空格错误 | “，”后可加空格，使代码更加清晰 | line58、line59 | |
| missing-final-newline 缺少换行 | 语句末尾换行 | line65 | |
| missing-docstring 缺少模块字符串 | 该错误可能由于本组成员在进行代码审查时，未下载对应的包 | line1、16、20、39 | |
| multiple-imports 在同一行import了多个接口 | 一般都是代码规范插件的问题 | line2 | |
| invaild-name 无效命名 |
变量名应既简短又具有描述性，应尽量使用小写的Python变量名 |
line8、9、13、16、20、42、45、57 | |
| E | import-error import出错 | 该错误可能由于本组成员在进行代码审查时，未下载对应的包 | line3、4、5、6 |
|
W |
unused-argument 未使用参数 | 删除未使用参数 | line20 |
| unused-variable 未使用变量 | 删除未使用变量 | line55、60 |
注：
(C) 惯例。违反了编码风格标准
(R) 重构。写得非常糟糕的代码。
(W) 警告。某些 Python 特定的问题。
(E) 错误。很可能是代码中的错误。
(F) 致命错误。阻止 Pylint 进一步运行的错误。
4、通过github issues向项目维护者提交问题
五、实验小结
1、安装pylint时，python目录下运行pip install python出错：
这是因为通常情况下，在windows里，pip 命令都是通过 cmd 或者 powershell 来调用运行，而一般中文的windows系统的 cmd 和 powershell 环境使用的编码格式默认为 GBK
，python 里面默认使用 utf-8 来解码，所以有可能遇到解码错误。
解决方法就是利用 Traceback 信息里，找到 $PYTHONROOT/lib/site-packages/pip/compat/__init__.py 文件，找到 75 行，return s.decode(‘utf_8‘) 也就是引发异常的代码处，
把 "utf-8" 替换成 "gbk" 再运行就可以正常安装了。如果不想每次遇到这个异常都进来改一次， 可以把这一行替换成一组 try...catch... ，如果 utf-8 解码失败，则自动调用 gbk 解码。
2、pycharm集成pylint时，配置parameters以及working directory要注意规范，否则无法运行pylint.
3、加深了对Python代码规范的理解，认识到了代码规范的重要性。
标签：异常 超过 理解 截图 链接 源代码 遇到 字符 mod
原文地址：https://www.cnblogs.com/cloudyyy/p/12885250.html
