编码规范和代码重构的一些建议

首先推荐两个工具,一个是Resharper 一个是dotcover

  1. 代码应在注释较少的前提下能让别人读的懂,而不是只能让机器读的懂
  2. 如果自己都觉得自己写的代码丑,那么请您重构
  3. 尽可能的避免重复代码
  4. 必要的时候可以使用静态变量来保存查询出来的数据,建议将静态变量设置为只读的并且私有的,通过只读属性来访问它
  5. 区别对待静态变量和静态属性
  6. 静态属性中直接调用方法,不会带来性能的提升,而静态变量可以
  7. 谨慎使用可读的、非私有的静态变量或属性
  8. 代码的暴露程度尽可能的低(能用internal不用protected)
  9. 参数的数据类型尽可能的严格(比如能用int不用string)
  10. 局部变量的定义尽可能的和它的使用挨进,这样便于代码的重构
  11. 如果局域变量在使用之前参涉及到了代码逻辑中,应当它们重构为方法
  12. 如果代码中出现了嵌套的循环或条件判断,那么这段代码该重构了
  13. 建议使用using引入命名空间,而不是在声明对象的时候将命名空间写到声明里
  14. 移除未使用的using
  15. 重构时干掉多余的注释和注销掉的代码
  16. 无特殊情况建议一个方法最好不要超过30
  17. 必要的时候可以使用linq进行多个list的连结查询
  18. 尽量用List<T>来代替DataTable,这样在使用的过程中比较方便,并且避免了过多的装箱、拆箱
  19. 如果自己都觉得自己写的代码丑,那么请重构它

如有不对之处,请拍砖,并指正,谢谢!

待续

编码规范和代码重构的一些建议,布布扣,bubuko.com

时间: 2024-08-01 23:04:00

编码规范和代码重构的一些建议的相关文章

C#编码规范之代码的增删改约定

C#编码规范,代码的增删改约定: 增加 #region add by Tome 2018-9-20 //原因:描述 int a = GetScale(obj, col); #endregion 删除 ,删除的代码确实没存在的意义,可以考虑1年后直接从文件中移除掉. #region delete by Tome 2018-9-20 //原因:描述 /*int a = GetScale(obj, col);*/ #endregion 修改 ,下面演示了支持多次修改的情况.约定:最近一次改region

Android 编码规范及代码风格

一.常见的命名规范  1.Pascal命法: 每个单词的首字母大写. 如:PersonName.SchoolName     2.Camel命名法: 第一个单词的首字母小写,其余单词的首字母大写.如:personName.schoolName     3.匈牙利命名法: 变量名=属性+类型+对象描述. 如:m_intMaxDate 属性:全局变量(g_).常量(c_).成员变量(m_).静态变量(s_) 类型:函数(fn).句柄(hand).长整型(long).布尔(bool).浮点型(floa

[转载]Objective-C开发编码规范:4大方面解决开发中的规范性问题

Objective-C 编码规范,内容来自苹果.谷歌的文档翻译,自己的编码经验和对其它资料的总结. 概要 Objective-C 是一门面向对象的动态编程语言,主要用于编写 iOS 和 Mac 应用程序.关于 Objective-C 的编码规范,苹果和谷歌都已经有很好的总结: Apple Coding Guidelines for Cocoa Google Objective-C Style Guide 本文主要整合了对上述文档的翻译.作者自己的编程经验和其他的相关资料,为公司总结出一份通用的编

PEP8 Python 编码规范

PEP8 Python 编码规范 一 代码编排 1 缩进.4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格.2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号.换行点要在操作符的后边敲回车.3 类和top-level函数定义之间空两行:类中的方法定义之间空一行:函数内逻辑无关段落之间空一行:其他地方尽量不要再空行. 二 文档编排 1 模块内容的顺序:模块说明和docstring-import-globals&constants-其他定义.其中import部

Objective-C 编码规范

Objective-C 编码规范,内容来自苹果.谷歌的文档翻译,自己的编码经验和对其它资料的总结. 概要 Objective-C 是一门面向对象的动态编程语言,主要用于编写 iOS 和 Mac 应用程序.关于 Objective-C 的编码规范,苹果和谷歌都已经有很好的总结: Apple Coding Guidelines for Cocoa Google Objective-C Style Guide 本文主要整合了对上述文档的翻译.作者自己的编程经验和其他的相关资料,为公司总结出一份通用的编

Objective-C开发编码规范

Objective-C 编码规范,内容来自苹果.谷歌的文档翻译,自己的编码经验和对其它资料的总结. 概要 Objective-C 是一门面向对象的动态编程语言,主要用于编写 iOS 和 Mac 应用程序.关于 Objective-C 的编码规范,苹果和谷歌都已经有很好的总结: Apple Coding Guidelines for Cocoa Google Objective-C Style Guide 本文主要整合了对上述文档的翻译.作者自己的编程经验和其他的相关资料,为公司总结出一份通用的编

python编码规范[转载]

PEP8 Python 编码规范 一 代码编排1 缩进.4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格.2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号.换行点要在操作符的后边敲回车.3 类和top-level函数定义之间空两行:类中的方法定义之间空一行:函数内逻辑无关段落之间空一行:其他地方尽量不要再空行. 二 文档编排1 模块内容的顺序:模块说明和docstring—import—globals&constants—其他定义.其中import部分,

PEP8 Python 编码规范整理--转自豆瓣

http://www.douban.com/note/134971609/ PEP8 Python 编码规范 一 代码编排1 缩进.4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格.2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号.换行点要在操作符的后边敲回车.3 类和top-level函数定义之间空两行:类中的方法定义之间空一行:函数内逻辑无关段落之间空一行:其他地方尽量不要再空行. 二 文档编排1 模块内容的顺序:模块说明和docstring—imp

python 编码规范PEP8

PEP8 Python 编码规范整理 无规矩不成方圆, 学习python也要遵循相关的编码规范 PEP8 Python 编码规范 一 代码编排 1 缩进.4个空格的缩进(编辑器都可以完成此功能),不使用Tap,更不能混合使用Tap和空格. 2 每行最大长度79,换行可以使用反斜杠,最好使用圆括号.换行点要在操作符的后边敲回车. 3 类和top-level函数定义之间空两行:类中的方法定义之间空一行:函数内逻辑无关段落之间空一行:其他地方尽量不要再空行. 二 文档编排 1 模块内容的顺序:模块说明