引言
为保证开发代码的整洁,保持代码风格的一致性,提高可读性和可维护性,制定此代码编写规范,供ERP项目开发使用。
规范参考以下三处:
PEP8编码风格
PEP8是Python的官方编码风格指南,强调代码的可读性和一致性
Odoo编码指南
https://www.odoo.com/documentation/18.0/contributing/development/coding_guidelines.html
正确的代码可以提高可读性、简化维护、帮助调试、降低复杂性并提高可靠性。这些指南应该适用于每个新模块和所有新开发。
通用规范
一:【避免在程序中使用魔鬼数字,必须用有意义的常量来标识。】
二:【明确方法的功能,一个方法仅完成一个功能。】
三:【方法参数不能超过5个】
四:【方法调用尽量不要返回null,取而代之以抛出异常,或是返回特例对象(SPECIAL CASE object,SPECIAL CASE PATTERN);对于以集合或数组类型作为返回值的方法,取而代之以空集合或0长度数组。】
五:【在进行数据库操作或IO操作时,必须确保资源在使用完毕后得到释放,并且必须确保释放操作在finally中进行。】
六:【异常捕获不要直接catch (Exception ex) ,应该把异常细分处理。】
七:【对于if „ else if „(后续可能有多个else if …)这种类型的条件判断,最后必须包含一个else分支,避免出现分支遗漏造成错误;每个switch-case语句都必须保证有default,避免出现分支遗漏,造成错误。】
八:【覆写对象的equals()方法时必须同时覆写hashCode()方法。】
九:【禁止循环中创建新线程,尽量使用线程池。】
十:【在进行精确计算时(例如:货币计算)避免使用float和double,浮点数计算都是不精确的,必须使用BigDecimal或将浮点数运算转换为整型运算。】
Python编程规范修炼-PEP8规范解读:https://zhuanlan.zhihu.com/p/161891805
什么是PEP8:https://blog.csdn.net/linyichao123/article/details/128744894
【开发规范01】-华为编程军规:https://blog.csdn.net/Alex_81D/article/details/141922915
【Python】编程规范01-类定义: https://blog.csdn.net/Alex_81D/article/details/142105111