软件工程:第二章第1节

参考来源: 学堂在线 - 《软件工程(自主模式)》
自用课件链接:编程过程与规范.pdf


编程是一门艺术,它能够展示结构之美、构造之美、表达之美

高质量的代码,不能只是运行正确的
,还要求做到可读性强易于维护简洁高效

软件编程工作

软件编程是一个复杂而迭代的过程,它不仅仅是编写代码,还应该包括代码审查、单元
测试、代码优化、集成调试等一系列工作(从系统模型到源代码)。

软件编程规范

定义:与特定语言相关的描写如何编写代码的规则集合

现实
• 软件全生命周期的 70% 成本是维护
• 软件在其生命周期中很少由原编写人员进行维护

目的
• 提高编码质量,避免不必要的程序错误
• 增强程序代码的可读性、可重用性和可移植性

建议学习使用Google编程规范:https://github.com/google/styleguide

「ps」:因为还没有充分接触到Python,所以下面用Python举的例子之摘录了自己感兴趣的一部分,以后有机会可能会补全,再次指出。

Python编程规范:程序模板

Python编程规范:注释

• 形式1:由 # 开头的“真正的”注释,说明选择当前实现的原因以及这种实现的原理和难点;

• 形式2:文档字符串(""" """),说明如何使用包、模块、类、函数(方法),甚至包括使用示例和单元测试。

书写注释应注意:

学会只编写够用的注释,过犹不及,重视质量而不是数量。

• 好的注释解释为什么,而不是怎么样

• 当修改代码时,需要同时维护代码周围的所有注释

Python编程规范:命名

命名规范应注意:

命名名称一目了然,不需要读者去猜,甚至不需要注释

编写自文档化的代码

• 尽量使得唯一能完整并正确地描述代码的文档是代码本身

• 编写便于阅读简单易懂的代码

命名规范举例

  • 类名:驼峰风格首字母大写
  • 变量名:下划线风格

Python编程规范:语句


标签: none

添加新评论