【PDF】Python基础教程,廖雪峰菜鸟教程规范

1）名称

要准确支付，请使用上下文来简化命名，可以搜索要读取的名称，可以搜索。对于界面的命名，一个是前缀“i”，另一个是添加“iclic”;出于抽象类的名称，一个是带来前缀“摘要”，另一个是没有前缀。

推荐阅读：python基础教程,自动化运维技术与最佳实践教程下载

（2）评论

评论的内容主要包括四个方面：该怎么做，为什么，如何做到，如何使用它。一些边界条件，特殊情况和功能输入，输出和异常的指令。

写一些摘要描述，特殊情况。对于逻辑复杂代码或相对长的函数，通过摘要注释，代码结构更加清晰，更具组织。

类别和函数必须写入注释，并尽可能写入，详细信息，并且在函数内更多的注释应该相对较小，一般依赖于良好的命名，精炼功能，解释性变量，摘要注释增加代码可读性。

（3）类，功能规模

当类代码读取时，您不知道在实现功能时应使用哪个函数。如果要使用半天未找到哪个函数，只需使用一个小功能来介绍整个类（类当有许多与此功能无关的函数时），这表明行数班级太多了。

有一种说法的功能码线的数量，存在不超过显示的垂直高度的说法。

（4）一行代码的长度

一行代码不超过IDE显示的宽度。您需要滚动鼠标以查看行的所有代码，这显然不利于读取代码。

（5）良好使用空白分割单元块

在类之间的成员变量之间，静态成员变量和普通成员变量之间，在功能甚至成员变量之间，可以通过添加空间线来进行这些不同模块的代码。边界更加明确。

本文来源：https://www.xuexi158.com/411.html