软件工程之高质量代码（编码规范）

软件编码规范是与特定语言相关的描写如何编写代码的规则集合。
编码规范的目的是提高编码质量，避免不必要的程序错误，增强程序代码的可读性、可重用性和可移植性。

Python的注释规范
形式1：由 # 开头的“真正的”注释，说明选择当前实现的原因以及这种实现的原理和难点；
形式2：文档字符串，说明如何使用包、模块、类、函数（方法），甚至包括使用示例和单元测试。

命名规范
要编写需要外部文档支持的代码，这样的代码是脆弱的，要确保你的代码本身读起来就很清晰。

语句规范

不要在行尾加分号
类名应为驼峰风格且首字母大写，
变量名应为下划线风格
使用文件时应注意显式地调用close()，或使用with
每行只写一条语句
import 语句应遵循的原则：
• import 次序：先 import Python 内置模块，再 import 第三方模块，最后 import 自己开发的项目中的其它模块；这几种模块中用空行分隔开来。 • 一条 import 语句 import 一个模块。
• 当从模块中 import 多个对象且超过一行时，使用如下断行法（py2.5以上版本）：
• 不要使用 from module import *，除非是 import 常量定义模块或其它你确保不会出现命名空间冲突的模块。

更多完整内容请参考Google Python Style Guide： http://google.github.io/styleguide/pyguide.html
同时里边含有其他语言的代码规范。
参考自学堂在线。

软件工程之高质量代码（编码规范）相关推荐

如何才能写出高质量代码
提醒:在发布作品前,请把不需要的内容删掉. 你是否曾经为自己写的代码而感到懊恼?你是否想过如何才能写出高质量代码?那就不要错过这个话题!在这里,我们可以讨论什么是高质量代码,如何写出高质量代码等问题. ...
读书笔记：编写高质量代码--web前端开发修炼之道（二：5章）
读书笔记:编写高质量代码--web前端开发修炼之道这本书看得断断续续,不连贯,笔记也是有些马虎了,想了解这本书内容的童鞋可以借鉴我的这篇笔记,希望对大家有帮助. 笔记有点长,所以分为一,二两个部分: ...
《编写高质量代码：改善c程序代码的125个建议》——第1章数据，程序设计之根本建议1：认识ANSI C...
本节书摘来自华章计算机<编写高质量代码:改善c程序代码的125个建议>一书中的第1章,建议1,作者:马伟更多章节内容可以访问云栖社区"华章计算机"公众号查看. 第1 ...
编写高质量代码:改善Java程序的151个建议(第1章:JAVA开发中通用的方法和准则___建议1~5)...
The reasonable man adapts himself to the world; The unreasonable one persists in trying ...
[翻译Joel On Software]Joel测试：12步写出更高质量代码/The Joel Test: 12 Steps to Better Code
Joel on Software The Joel Test: 12 Steps to Better Code Joel测试:12步写出更高质量代码 byJoel Spolsky Wednesday, ...
从哪些维度评判代码质量的好坏？如何具备写出高质量代码的能力？
文章目录如何评价代码质量的高低? 最常用的评价标准有哪几个? 1. 可维护性(maintainability) 2. 可读性(readability) 3. 可扩展性(extensibility) ...
如何提高代码质量，或者说高质量代码的特征是什么
高质量代码的三大要素: 可读性.可维护性和可变更性!! 做好代码规范.提高代码质量,能显著增强代码的可读性.可维护性和可变更性.努力提高代码的读写可维护性,是做好代码规范的必要非充分条件.代码规范和架 ...
20230503 Javascript下载页面pdf的高质量代码
目录一. 前言二.高质量代码的特征三.编程实践四. 实际代码五. 总结你是否曾经为自己写的代码而感到懊恼?你是否想过如何才能写出高质量代码?那就不要错过这个话题!在这里,我们可以讨论什么是 ...
转载----编写高质量代码:改善Java程序的151个建议(第1章:JAVA开发中通用的方法和准则___建议1~5)...
阅读目录建议1:不要在常量和变量中出现易混淆的字母建议2:莫让常量蜕变成变量建议3:三元操作符的类型务必一致建议4:避免带有变长参数的方法重载建议5:别让null值和空值威胁到变长方法 ...

软件工程之高质量代码（编码规范）

软件工程之高质量代码（编码规范）

软件工程之高质量代码（编码规范）相关推荐

最新文章

热门文章