从软件开发角度,审视编码规范

本文综述:编码实践中遇到的问题总结和分析(实践总结)

1. 将单一的功能独立出来,不要将代码写成一坨坨的;功能独立出来后,能够从主程序中看出主要的逻辑(易于整理处理文档),而不是什么都看不出来。

2. 适当的做重构,不要等到代码写完了再考虑重构,重复的部分尽量不要写。

3. 代码做到简洁、干净、不做过多的逻辑判断。

4. 编码中发现:如果一个方法需要很长时间执行完成,而其后的执行逻辑仅仅是赋值操作,很可能后面的代码会在前执行(打印Log,跟踪代码逻辑)。

5. (撰写代码方法学)写一个功能,获取一个状态,都需要进行测试。“走一步,测试一次”!避免不必要的坑(承接上述4,Log跟踪逻辑执行流程)。

6. 定义常量字段,可在Interface中定义,声明的字段默认使用:public static final修饰。

7. 测试和开发之间的距离,如何在开发一个功能后,进行自测?

8. 出现问题时,向多个人了解情况,一个人说的内容不一定是正确的(很可能)。这也是做事的方法学。

9. 写一个方法后,设置相应的返回值,用于判断处理结果。

每一个要点的背后都有一个故事支撑着!

时间: 2025-01-05 15:34:53

从软件开发角度,审视编码规范的相关文章

【tool】从软件开发角度谈测试案例设计

我概括了以下几点内容,从软件开发的角度,来讨论一下在进行软件测试时,测试案例的 设计应从哪些发面入手: 1. 用户需求:用户需求指出系统或应用软件应当做什么和不应当做什么,软件开发过程中的需求定义阶段,由于没有进行交流.交流错误或者交流不充分,都给软件设计造成误导.测试案例的设计首先必须从用户需求出发,我们在测试过程中发现许多争论不清的错误和矛盾正是出于用户需求的不明确.不满足用户需求的软件,其它方面即使很完美,也不是一个合格的软件. 2. 软件特征:目前的软件系统和应用软件是比较复杂的,客户端

软件开发者在软件开发过程中的编码规范和习惯

在软件开发过程中,软件开发者在编写代码过程要有大局观 所谓的大局观,指的是编写的代码的复用性! 不要为了完成任务或是功能,就随意的命名或使用某些样式代码让它实现某种功能! 在HTML和CSS中,某些css命名可能在一些html中用到,那么这时就要注意代码的复用性! 那么在哪些页面可能会用到呢,比如注册.登陆等等,不同用户的登陆,看到的样式可能不一样,但有的页面可能会达到相同的样式,div的命名 tr .td中用到的class就可能在多个页面中都用到,而且命名让人一眼就明白,在哪些页面用到,所起到

Android面试、开发之高手 编码规范与细节

注释 [规则1]必须用 javadoc 来为类生成文档.不仅因为它是标准,这也是被各种java 编译器都认可的方法. [规则2]在文件的开始部分应该有文件的说明信息,应包含如下信息: (1)版权信息: (2)文件名: (3)功能描述: (4)作者: (5)完成日期: (6)版本信息: (1.1)eclipse类模版: /** * ? 2012 amsoft.cn * 名称:${file_name} * 描述:${todo}. * @author ${user} * @date:${date} $

软件开发项目进度控制浅谈

一.影响软件开发项目进度的因素 要有效地进行进度控制,必须对影响进度的因素进行分析,事先或及时采取必要的措施,尽量缩小计划进度与实际进度的偏差,实现对项目的主动控制.软件开发项目中影响进度的因素很多,如人为因素.技术因素.资金因素.环境因素等等.在软件开项目的实施中,人的因素是最重要的因素,技术的因素归根到底也是人的因素.软件开发项目进度控制常见问题主要是体现在对一些因素的考虑上.常见的问题有以下几种情况: 1.80-20原则与过于乐观的进度控制 80-20原则在软件开发项目进度控制方面体现在:

C#程序编码规范 ----转

1.目的 为了保证企业编写出的程序都符合相同的规范,保证一致性.统一性而建立的程序编码规范. 全 面的编码标准包含代码结构的所有方面.虽然开发人员在实现标准时应慎重,但只要应用了就应该坚持.完成的源代码应该反映出一致的样式,就像一个开发人员在 一个会话中编写代码一样.在开始软件项目时,建立编码标准以确保项目的所有开发人员协同工作.当软件项目并入现有的源代码时,或者在现有软件系统上执行维 护时,编码标准应说明如何处理现有的基本代码. 源 代码的可读性对于开发人员对软件系统的理解程度有直接影响.代码

让你提前认识软件开发(46):首先是为人编写程序,其次才是计算机

第3部分 软件研发工作总结 首先是为人编写程序,其次才是计算机 "首先是为人编写程序,其次才是计算机",这是软件开发的基本要点,软件的生命周期贯穿于产品的开发.测试.生产.发布.用户使用.版本升级和后期维护等长期过程中,只有易读.易维护的软件代码才具有生命力. 在实际的软件开发过程中,可能是由于工作很忙的原因,很多开发人员只注重实现程序的基本功能,而忘记了编程规范,因此写出来的代码只能让计算机看懂,人要看懂很不容易.更有甚者,有些项目组为了赶进度,明确要求组员以实现产品功能为主,代码能

编码规范之编写灵活、稳定、高质量的 HTML 和 CSS 代码的规范

不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的. 因此,编写灵活.稳定.高质量的 HTML 和 CSS 代码,是每一个技术人员的基本操守. HTML ************************************************************************ 语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法. 嵌套元素应当缩进一次(即两个空格). 对于属性的定义,确保全部使用双引号,绝不要使用单

软件开发各类文档模板

http://blog.163.com/amanda_liyan/blog/static/5456169120093304520393/        可行性分析报告 1 引言 1.1 编写目的:阐明编写可行性研究报告的目的,提出读者对象. 1.2 项目背景:应包括  ● 所建议开发软件的名称  ● 项目的任务提出者.开发者.用户及实现软件的单位  ● 项目与其他软件或其他系统的关系. 1.3 定义:列出文档中用到的专门术语的定义和缩写词的原文. 1.4 参考资料:列出有关资料的作者.标题.编号

节选自“Discuz! 开放平台的编码规范”(通用的)

http://open.discuz.net/?ac=document&page=dev_coderule 本文字体字号大小(只针对本文编辑器): 项目描述                             字号          加重与否             例 重要内容标题                   18pt        重色                I. 代码编写规范,“序” 一般描述性文字                13px        不加重色