编码风格总结
编码风格总结
软件工程（编码风格）：
提示：5月19日学习记录，良好的代码风格
今天对代码风格学习进行了粗略的总结，日后完善
学习内容：
源程序代码的逻辑简明清晰、易读易懂是好程序的一个重要标准，为了做到这一点，应该从以下几个方面遵循相应的规则：
- 程序内部的文档
- 数据说明
- 语句构造
- 输入输出
- 效率
学习产出：
程序内部的文档包括：
标识符
即符号名，包括模块名、变量名、常量名等。这些名字应能反映它所代表的实际东西，应有一定实际意义。
例如，表示次数的量用Times，表示总量的用Total，表示平均值的用Average，表示和的量用Sum等。
命名规则： 名字应当选择精炼的、意义明确的名字。 必要时可使用缩写名字，但这时要注意缩写规则要一致。 要给每一个名字加注释。 在一个程序中，一个变量只应用于一种用途。注解
注解决不是可有可无的。
一些正规的程序文本中，注释行的数量占到整个源程序的1/3到1/2，甚至更多。注解分为序言性注释和功能性注释。
程序的视觉组织
代码整体要看着清晰，容易阅读。
数据说明
相同数据类型的变量放在一个区域并说明
当多个变量名在一个语句中说明时，应该按字母顺序排列这些变量，便于查找。
如果设计时使用了一个复杂的数据结构，则应该用注解说明用程序设计语言实现这个数据结构的方法和特点。
语句构造
每个语句都应该简单而直接，不能为了提高效率而使程序变得过分复杂；
也不要刻意追求技巧性，使程序编写得过于紧凑。
下述规则有助于使语句简单明了：
不要为了节省空间而把多个语句写在同一行；
尽量避免复杂的条件测试；
尽量减少对“非”条件的测试；
避免大量使用循环嵌套和条件嵌套；
利用括号使逻辑表达式或算术表达式的运算次序清晰直观。
输入输出风格
设计和编写程序的输入输出风格规则：
对所有输入数据都进行检验；
检查输入项重要组合的合法性；
保持输入格式简单；
使用数据结束标记，不要要求用户指定数据的数目；
明确提示交互式输入的请求、详细说明可用的选择或边界数值；
当程序设计语言对格式有严格要求时，应保持输入格式一致；
设计良好的输出报表；
给所有输出数据加标志。
效率
程序效率
程序的效率，是指程序的执行速度及程序所需占用的内存和硬盘存储空间。
程序编码，是最后提高运行速度和节省存储的机会了，因此，在此阶段不能不考虑程序的效率。
在把详细设计结果翻译成程序时，总可以应用下述规则：
√ 写程序之前，先简化算术的和逻辑的表达式；
√ 仔细研究嵌套的循环，以确定是否有语句可以从内层往外移；
√ 尽量避免使用多维数组；
√ 尽量避免使用指针和复杂的表；
√ 使用执行时间短的算术运算；
√ 不要混合使用不同的数据类型；
√ 尽量使用整数运算和布尔表达式。
在效率是决定性因素的应用领域，尽量使用有良好优化特性的编译程序，以自动生成高效目标代码。
输入输出效率
高效的输入／输出是
操作员能够十分方便、简单地录入输入数据，或者能够十分直观、一目了然地了解输出信息。
关于提高设备输入/输出效率的指导原则：
所有输入输出都应该有缓冲，以减少用于通信的额外开销。
对二级存储器的输入输出应该以信息组为单位进行。
如果“超高效的”输入输出很难被人理解，则不应采用这种方法。