Python Pylint编码规范学习笔记-1

Python Pylint编码规范学习笔记

（第1篇：文档注视、函数注释、变量定义）

本系列文章由ex_net（张建波）编写，转载请注明出处。

http://blog.csdn.net/ex_net/article/details/70182789

作者：张建波 邮箱： 281451020@qq.com  欢迎交流！

编程环境：

     VSCODE

     Python 2.7

     Pylint

一、文档注释及main函数编写

       敲入下面的代码，你会发现VSCODE给你贴上了“绿色波浪号”，虽然程序可以运行，但是实在让人受不了！用鼠标移动上去可以看到C0XXX 的警告提示。网上有很多大神推荐的办法就是：直接修改pylint的配置文件去禁用调这些绿色标记。

 (1)用3引号在文档第1行开始加注释
 (2)不要在行尾加分号(";"), 也不要用分号将两条命令放在同一行
 (3)编写函数时，一定要在函数体内，用3引号在加注释
 (4)脚本最后1行，一定要加空行（例如下图的第13行），但是不能出现任何内容“包括空格”
 (5)语句要顶格（左边）写，子程序块要锁进4个空格
 (6)如果你是一个C／C++老程序猿，习惯用main函数书写方式，一定要在 main() 调用前加上 if __name__ == '__main__': 语句

截图里没有出现一个“绿色波浪”，还不错吧！

二、变量的定义

  （1）函数体外定义的变量是全局的，必须采用全部大写字母

  （2）定义时，等号（“=”）两边需要加一个空格

三、函数编写规范示例

        （1）在函数内部冒号（“：”）的下一行，用 3引号书写函数的功能

        （2）如果函数有参数（Args），则还需要特别说明，例如下图的 calculate_r，可能的情况下再书写Raises注明可能发生哪些异常导致错误。

        （3）在写函数注释时，冒号（“：”）后面一定要加一个空格。

        （4）用 def 写函数名这一行的冒号（“：”）后面，不能有空格，只能是换行（回车）

       (5)如果函数有多个参数，则需要在逗号（“，”）后面加一个空格。

           例如下图，在bcd 和 deff 前都有一个“空格”