关于代码维护的一点点看法

关于最近代码的修改,本人存在一点小小的看法,提出来仅供参考。

1、  有关代码的规范性(大家基本都有一定的了解,但还是很有必要提一下)。

(1)       类型、属性、事件、方法、方法参数,必须添加注释(除了名称已经是自解释的)。

(2)       命名的规划,如 所有命名空间、类型名称使用Pascal风格(单词首字母大写);本地变量、方法参数名称使用Camel风格(首字母小写,其后每个单词的首字母大写)等。

(3)        HTML 代码,应有层次感,尽量保持整洁感,不需要的代码不要保留,没必要可有可无的属性、标签全部不要写。

(4)        JavaScript代码,注释需要说明“函数功能”、“传入参数”、“返回值”等。

2、  软件设计的规范性(确实感同身受,没有需求文档、数据设计文档及业务流程图,维护、修改或扩展相当麻烦(付出的代价大,效果差))。设计的合理性,功能的 简单直接简洁性,不应该把简单的东西复杂化,而应该把复杂的业务简单化,本人推崇系统的树状结构(除了业务需要以外)。

3、  框架的问题。一个系统为了好维护,在编写代码的时候,得先指明使用的框架模式,而不是凌乱的功能块编写方式;在编写的时候,得考虑好维护扩展时的方便性。完整部分可参考软件设计原则。

4、  框架的升级。现在MVC已经到了5.0,我们现在的项目还是2.0,可想而知,很多新特性我们都没有使用上,且3.0比2.0  有明显的改善。推崇mvc3.0+EF的模式,可以少写很多代码,少建很多文件类,少写很多存储过程(现有的功能点,js文件完全可以搬过去,唯一需要做 的,就是需要了解使用linq语句)。建议把业务逻辑部分独立出来,以达到MVC的最初目的。

5、  代码的重用性。

关于代码维护的一点点看法

上一篇:搭建cassandra单数据中心集群(笔记)


下一篇:甘特图应用之使用颜色的技巧