Skip to content

计科:week1 代码风格检查 #2

@wujr5

Description

@wujr5

week1 代码风格检查

一、用cpplint.py进行代码风格检查

Sicily系统没有在编程风格上作要求,只要你的代码能运行,输入输出没问题,就可能可以通过。但是这样会写出可能可读性很差的代码。因此我们TA强烈要求同学们一定要注意自己的代码编写的风格。

下面介绍一个工具的使用来进行代码风格检查。

步骤1:安装python

教程:安装python

要注意的是,教程中说的系统变量就是python的安装路径。

步骤2:检查python是否安装成功

  1. 打开命令行窗口(win键+R;输入cmd;回车)如下:
  2. 如果安装成功,在命令行窗口输入python将会出现以下的输出:

步骤3:下载cpplint.py

点击下载cpplint.py

步骤4:代码风格检查

  1. cpplint.py文件复制到你的程序代码所在的目录。比如:

  2. 打开命令行窗口,方法就是步骤2的第一点。导航到代码所在目录。

    cd命令的含义是打开目录,dir命令的含义是查看该目录下地文件和文件夹

  3. 运行命令

    python cpplint.py --filter=-whitespace/tab filename.cpp
    

    注意finename.cpp是你的源代码的文件名

    然后就会有如下的输出:

    注意错误,如test.c:7: Line ends in whitespace. Consider deleting these extra spaces. [whitespace/end_of_line] [4]test.c指的是文件名,7指的是行号,后面的 Line ends in whitespace. Consider deleting these extra spaces. [whitespace/ end_of_line] [4]指的是代码中出现的错误。

步骤5:根据输出的改善代码

根据输出的错误,逐行改进代码。直到错误数目为0。如Total errors found: 0

步骤6:提交到Sicily

把通过google style的cpplint.py测试的代码,也就是Total errors found: 0,再把代码提交到Sicily。

总结

进行google style风格检测的目的是让同学们写出可读性良好的代码。按照上面的流程编写代码,能帮助你养成良好的编程习惯。希望同学们重视。

有任何问题欢迎评论。我们会持续改进。

参考

  1. cmd命令行大全
  2. google style guide
  3. cpplint

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions