trenitalia:养成良好的编程风格

来源:百度文库 编辑:偶看新闻 时间:2024/04/29 04:49:13
  要便于程序的调试和维护,这就要求编写的程序不仅自己看得懂,而且也要让别人能看懂。程序的可阅读性是很重要的!为了提高程序的可阅读性,要建立良好的编程风格。 好的程序设计风格,包括良好的代码设计,函数模块,接口功能以及可扩展性等,更重要的就是程序设计过程中代码的风格,包括缩进,注释,变量及函数的命名,泛型和容易理解。(代码的风格需要自己在平时写代码时逐步注意、逐渐完善!) 编写程序应符合软件工程的思想。例如 自顶向下模块化的程序设计(TOP——DOWN)。对要完成的任务进行分解,根据需求划分成很多子模块,并设计好相应的接口、变量和方法。逐层逐个的进行定义、设计、编程和测试,直到所有层上的问题都由实际程序来解决。先从全局分析、设计,然后像做填空题一样逐个完善。就能写出具有层次结构的程序。相比于“需要一个什么功能就去写一个功能,然后一个一个累加起来 直到完成要求”的编程思路要好得多! 好的程序,应该具有很好的可阅读性(编程风格,注释是很关键的)、健壮性(对错误及异常的处理)、可拓展性和可维护性(对于很多实际开发的产品,产品的更新和维护也是很重要的一块)。 

源程序文档化

  (1)标识符应按意取名。   (2)程序应加注释。注释是程序员与日后读者之间通信的重要工具,用自然语言或伪码描述。它说明了程序的功能,特别在维护阶段,对理解程序提供了明确指导。注释分序言性注释和功能性注释。序言性注释应置于每个模块的起始部分,主要内容有:     ①说明每个模块的用途、功能。     ②说明模块的接口:调用形式、参数描述及从属模块的清单。     ③数据描述:重要数据的名称、用途、限制、约束及其他信息。     ④开发历史:设计者、审阅者姓名及日期,修改说明及日期。   功能性注释嵌入在源程序内部,说明程序段或语句的功能以及数据的状态。注意以下几点:    ①注释用来说明程序段,而不是每一行程序都要加注释。    ②使用空行或缩格或括号,以便很容易区分注释和程序。    ③修改程序也应修改注释。

数据说明原则

  为了使数据定义更易于理解和维护,有以下指导原则:   (1)数据说明顺序应规范,使数据的属性更易于查找,从而有利于测试、纠错与维护。例如按以下顺序:常量寿命、类型说明、全程量说明、局部量说明。   (2)一个语句说明多个变量时,各变量名按字典序排列。   (3)对于复杂的数据结构,要加注释,说明在程序实现时的特点。

语句构造原则

  语句构造的原则是:简单直接,不能为了追求效率而使代码复杂化。为了便于阅读和理解,不要一行多个语句。不同层次的语句采用缩进形式,使程序的逻辑结构和功能特征更加清晰。要避免复杂的判定条件,避免多重的循环嵌套。表达式中使用括号以提高运算次序的清晰度等等。

输入输出原则

  输入和输出在编写输入和输出程序时考虑以下原则:   (1)输入操作步骤和输入格式尽量简单。   (2)应检查输入数据的合法性、有效性,报告必要的输入状态信息及错误信息。   (3)输入一批数据时,使用数据或文件结束标志,而不要用计数来控制。   (4)交互式输入时,提供可用的选择和边界值。   (5)当程序设计语言有严格的格式要求时,应保持输入格式的一致性。   (6)输出数据表格化、图形化。   输入、输出风格还受其他因素的影响,如输入、输出设备,用户经验及通信环境等。

追求效率原则

  指处理机时间和存储空间的使用,对效率的追求明确以下几点:   (1)效率是一个性能要求,目标在需求分析给出。   (2)追求效率建立在不损害程序可读性或可靠性基础上,要先使程序正确,再提高程序效率,先使程序清晰,再提高程序效率。   (3)提高程序效率的根本途径在于选择良好的设计方法、良好的数据结构算法,而不是靠编程时对程序语句做调整。     解决小问题的基本步骤:    一、分析问题,确定输入和输出的数据    二、寻找解决问题的算法(方法和过程)    三、确定算法中要使用的数据(包括中间过程所使用的数据)    四、编写程序  设计模式更多的考虑是扩展和重用。设计模式和框架是不同的。