程序设计要遵循一定的开发方法及思想,以下有一个不是程序设计过程中应该遵循的开发方法,它是数据结构优先原则。
任何设计活动都是在各种约束条件和相互矛盾的需求之间寻求一种平衡,程序设计也卖链兄不例外。在计算机技术发展的早期,由于机器资源比较昂贵,程序的时间和空间代价往往是设计关心的主要因素;随着硬件技术的飞速发展和软件规模的日益庞大,程序的结构、可维护性、复用性、可扩展性等因素日益重要。
扩展资料:
程中袭序设计的注意事项:
1,使用顺序、选择、唤唤循环等有限的基本结构表示程序逻辑。
2,选用的控制结构只准许有一个入口和一个出口
3,程序语句组成容易识别的块,每块只有一个入口和一个出口。
4,复杂结构应该用基本控制结构进行组合或嵌套来实现。
5,程序设计语言中没有的控制结构,可用一段等价的程序段模拟,但要求改程序段在整个系统中应前后一致。
6,严格控制GOTO语句。
参考资料来源:
百度百科-C++程序设计:思想与方法
1提高编码质量,代码可读性和可维护性。2代码编写规范
2.1删除所有无用代码
2.2必须给代码添加注释,一个类的注释字数不得小于代码的百分之20%
2.3建议遵循30秒原则灶瞎。如果另一个程序员无法在三十秒内无法知道你的函数在做什么,如何做以及为什么要这样做,那么说明你的代码是难于维护的,需要得到提高。
2.4一个函数的代码长度不允许超过100行,超过一百行的函数建议在不破坏原子性的基础上进行拆分。
2.5变量都应在方法或者类的头部集中定义
2.6保证一行代码只做一件事
2.7使用括号来控制 *** 作符的运算顺序,以免使用java默认的 *** 作符优先级顺序。
2.8代码格式化:对代码进行格式化,再进行提交。
2.9接口不允许没有方法或者变量的声明
3.命名规范
3.1各种标识符的命名要使用有实际意义的英文单词或者英文单词缩写,缩写词及英文单词要收录在项目的简写词汇表中。切忌使用阿拉伯数字和拼音进行命名。
3.2类名:首字母大写,每个单词首字母都需要大写。
3.3方法名:首字母小写,其余单词首字母都需大写。
3.4全局变量,和常量名称要求全部字母大写。
3.5参数名称与局部变量基本相同,区别在于参数名称需要加上冠词a,an或者在单词结尾以s结束。
4.注释规范
4.1注释需要注意的事项:
★注释应该用中文清晰表达意思,应该是程序看起来更清晰,更容易理解
★注释要尽量简明,避免装饰性的注释。
★注释不但要说明做什么,还应当说明为什么要这样做。最好先写注释表明要做什纤核么,再进行编码。
4.2类的注释
★类的用途,目的。包括其他人感兴趣的介绍。
★已知bug,当然最好是修改好所有的错误,但有时可能暂时没有办法修改,或者没有时间修改。
★开发和维护该类的历史列表,记录每一次修改的作者,日期,修改的内容。
★列举类的各种稳定状态,说明调用成员函数使类的状态产生的变迁(可选)。
★同步问题(可选)
★对主要的算法必须加以说明,主要流程必须给予引导性说明
标准格式:
如果对已经版本话的类进行了修改,需要按照如下格式为每一次修改附加修改历史记录:
//修改人+修改日期
//修改说明范例:
//李四2010/07/02
//添加错误数据修改后继续批量保存的处理函数saveBatch(
@Bind(key="itemParams",defaultValue="")StringitemParams,
@Bind(key="pid",defaultValue="")Stringpid)。
//王小二2010/07/02
4.3接口注释:
★接口的注释风格基本与类的注释风格相同;
★在别人使用接口之前毁辩掘,必须了解接口所包含的概念。检验一个接口是否应该定义的简单方法是:你是否能★够容易的描述接口的用途;
★接口如何应当和不应当被使用。开发者需要知道该接口如何被使用,也希望知道该接口不能被怎样使用。
4.4函数的注释
★函数头注释必须包括:函数执行了什么功能,为什么要这样处理;函数处理过程中对对象的哪些属性
★可能进行更改;函数执行前后,对象的状态;
★比较、循环等控制结构加注释(可选);
★在代码的功能并非一目了然的情况下,应当说明为什么要这样做;
★局部变量必须加注释;
★复杂难写的代码必须加注释;
4.5类属性的注释:
★描述域的用途。使别人知道如何去使用它;
★对于有着复杂事物规则的域,可以加入范例来说明。有时候一个简单的小例子,抵的上千言万语;
欢迎分享,转载请注明来源:内存溢出
评论列表(0条)