(课堂讨论)关于如何使代码得到有效维护
2016-12-19 21:07
330 查看
要想使代码得到有效的维护,就一定要注意有关代码的规范性(大家基本都有一定的了解,但还是很有必要提一下)。
(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、 代码的重用性。
(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、 代码的重用性。
相关文章推荐
- 如何快速有效编写可维护代码
- 如何编写不可维护的代码
- (论坛答疑点滴)如何判断链接是否有效并且如果有效的话得到源代码
- 关于如何限制exchange可上传附件大小的讨论
- 如何在aspx页面中得到aspx.cs后台代码中的值
- 关于如何得到web.config中的数据库连接字符串
- 如何写不可维护的代码-程序设计篇
- TIP: 如何最快得到VS2008示例代码? Help > Samples
- 关于如何对待技术框架和业务框架的讨论
- 如何从PIMAGE_IMPORT_DESCRIPTOR节,得到某个API函数(导入函数)代码地址
- 如何编写不可维护的代码
- 在Blog中插入QQ天气预报如何得到所在城市名称相应的代码?
- 如何编写优质、高效、益于维护的C++代码
- 关于中国软件业如何建立信任机制和如何做事的讨论
- 在WPF中,如何得到任何Object对象的XAML代码?
- 关于Donews的记忆---如何得到下拉数据窗口的DDDW列的显示值?
- *关于如何得到查询记录的条数的方法^_^*
- 关于javascript如何判断某个字符是否占用两个字符的讨论
- 业务需要,得到了两段正则表达式的代码,JAVASCRIPT的(关于车牌号码的校验问题)。
- 关于如何有效锻炼肌肉的十个小贴士(转)