python规范
毕不了业啦
这个作者很懒,什么都没留下…
展开
-
python项目结构示例
记住项目的用户将是谁,并根据他们的需求进行调整。公共和开源项目是打算与大量用户分享的项目,可能涉及庞大的开发团队。这些项目应将项目文档的优先级放在与项目开发本身一样高。私有项目是专为个人使用而设计的项目,通常不与其他用户或开发人员共享。文档应该比私有项目需要的要严格一些,主要是为了帮助新成员加入项目或提醒贡献者/用户项目的新变化。共享项目是您与少数其他人在项目的开发和/或使用中进行合作的项目。“客户”或项目的用户仍然是您自己和那些少数人员使用项目的人员。许可证:描述您的项目正在使用的许可证的纯文本文件。原创 2024-05-11 11:58:10 · 291 阅读 · 0 评论 -
pep8规范
不同类型的命名规范有所不同,包括模块、类、异常、函数/方法、全局/类常量、全局/类变量、实例变量和方法名。- 函数/方法的文档字符串应描述其功能、输入参数和返回值,如果有必要还需描述复杂的算法和实现。- 使用字符串的 join 方法拼接字符串,使用字符串方法而不是 string 模块的方法。- 尽量不要在 try/except 中写过多的内容,只在可能抛出异常的地方使用。- 操作符两侧添加空格,例如 +、-、*、/、|、&、=。- 在列表、字典、元组、集合和参数列表的逗号后添加空格。原创 2024-05-11 11:56:27 · 347 阅读 · 0 评论 -
python命名规则
变量名可以包含英文、下划线、数字,但不能以数字开头,例如 `student_id`、`student1`、`student_1`、`_student` 都是合法的变量名,但 `1student` 是非法的。- **类(class)的命名**:采用驼峰命名法,首字母大写,私有类可用一个下划线开头,例如 `Farm`、`AnimalFarm`、`_PrivateFarm`。- **双下划线开头的命名**:表示类的私有成员,不能被导入和其他类变量访问。原创 2024-05-11 11:54:57 · 366 阅读 · 0 评论 -
python项目代码注释代码规范4
如果您使用argparse,那么可以省略参数特定的文档,假设它已经正确地在argparser.parser.add_argument函数的help参数中被文档化。脚本的文档字符串应放在文件的顶部,并且应该被充分文档,以便用户能够充分了解如何使用脚本。不同之处在于,现在文档的是模块以及模块内的任何函数,而不是类和类方法。1、包文档字符串应放在包的__init__.py文件的顶部。- 传递的任何参数(必需的和可选的),包括关键字参数。- 由模块导出的任何类、异常、函数和其他对象的列表。原创 2024-05-11 11:52:14 · 306 阅读 · 0 评论 -
python项目代码注释代码规范3
3、类构造函数参数应记录在__init__类方法docstring。各个方法应该使用各自的文档字符串进行记录。让我们来看一个简单的例子,表示动物的数据类。1、类文档字符串适用于类本身以及任何类方法。- 传递的任何参数(必需的和可选的),包括关键字参数。- 与接口相关的任何内容,如果该类打算被子类化。- 标记任何被认为是可选的或具有默认值的参数。- 对何时可以调用该方法有任何限制吗。- 任何公共方法,以及简短的描述。- 执行该方法时出现的任何副作用。- 对该方法及其用途的简要描述。- 任何类属性(特性)原创 2024-05-11 11:50:55 · 106 阅读 · 0 评论 -
python项目代码注释代码规范1
即使您的项目将最大行长度更改为大于推荐的80个字符,这也是正确的。- 规划和审核:在开发代码的新部分时,使用注释作为计划或概述该部分代码的一种方式可能是合适的。5. 算法描述:当使用算法时,特别是复杂的算法,解释算法的工作原理或如何在您的代码中实现它可以是有用的。最简单的理解代码的方法是阅读代码。当您使用清晰、易于理解的概念设计代码时,读者将能够快速理解您的意图。7. 您的代码的注释应保持简短和专注。1. 在Python中,注释是使用井号(#)创建的,应该是简短的句子,长度不超过几句话。原创 2024-05-11 11:46:29 · 210 阅读 · 0 评论 -
python项目代码注释代码规范2
2、在所有情况下,文档字符串都应该使用三重双引号(""")字符串格式。无论文档字符串是否是多行的,都应该这样做。至少,docstring应该是对您所描述的内容的快速总结,并且应该包含在一行中。而不是直接操作__doc__属性,字符串直接放在对象下面的特定位置将自动设置__doc__值。4、所有文档字符串的最大字符长度应该与注释相同(72个字符)。3、多行文档字符串用于进一步阐述摘要之外的对象。- 包和模块文档字符串:包、模块和函数。- 脚本文档字符串:脚本和函数。- 类文档字符串:类和类方法。原创 2024-05-11 11:48:50 · 153 阅读 · 0 评论