没有合适的资源?快使用搜索试试~ 我知道了~
资源详情
资源评论
资源推荐
Python 编码规范
修订记录
序号 版本号 修订内容概述 起草 审核 修订日期
1 1.0
新建
2020/10/30
1 Purpose and Scope 目的和范围
一个软件开发团队具有统一的编码规范,有如下积极意义:
1. 增强代码的强壮性、可读性、易维护性;
2. 使软件的结构和编码风格标准化,减少沟通成本,提高工作效率;
3. 使新的项目成员快速适应项目氛围;
4. 支持项目资源复用。
清晰可理解的源代码是软件可靠性和可维护性的主要因素,其具有以下
特质:
1. 自描述:软件的生命周期内,源代码的读远比写多。理想情况下,
源代码要具备自描述功能,代码即注释。
2. 唯一性:防止重复代码,相同的算法或逻辑应该在源代码中只表述
一次。
3. 一致性:一致的编码风格和相似结构,利于项目的生存和维护的可
持续性,而不依赖具体的开发人员。
4. 低耦合度:模块的功能明确,尽量降低模块间的相互依赖度,提高
代码的可移植性和可测试性。
5. 可维护性:被修改的能力。
6. 可靠性:指定时间间隔和环境条件下,按设计要求成功运行程序的
概率。
本规范是以 Python 为开发语言的编码规范,为医疗云部门人工智能算
法开发团队的原则性规范。
2 Terms and Abbreviations 术语和缩略语
无
3 Responsibilities and Authorities 职责和
权限
无
4 Coding Conventions 编码规范
4.1Naming Conventions 命名规范
4.1.1Overriding Principle 最重要的原则
那些暴露给用户的 API 接口的命名,应该遵循反映使用场景而不是实现的
原则。
4.1.2Names to Avoid 应该避免的名称
1. 单字符名称,除了计数器和迭代器
2. 包或模块名称中的连字符(-)
3. 双下划线开头并结尾的名称(python 保留,例如__init__)
4.1.3Naming Convenons 命名约定
1. “内部(Internal)”表示仅模块内可用,或者在类内时保护或私有的
2. 用单下划线(_)开头表示模块变量或函数是 protected 的,使用 from
x import * 时不会被包含
3. 用双下划线(__)开头的实例变量或方法表示类内私有
4. 将相关的类和顶级函数放在同一个模块里,没必要限制一个类一个模块
5. 对类名使用 Pascal 风格(CapWords),但是模块名应该用小写加下划
线的方式(如 lower_with_under.py)
剩余33页未读,继续阅读
医研-信息共享
- 粉丝: 0
- 资源: 11
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0