代码规范————代码问题总结1

代码的可读性问题分为：

1、命名类问题

a.缺乏统一性  b.没有考虑调用时的情形  c.本地语言命名   d.命名用词不当  e.超长的命名  f.命名含义模糊 
 g.命名与行为不一致  h.否定式命名  i.无意义命名  j.序号式命名  k.工程名为类名前缀  l.超短命名  m.匈牙利命名法

2、注释类问题

a 每步皆注释 b 错误的注释 c 修改履历注释 d 长方法中的分段注释 e 复制名称的注释 f 复制文档的注释 g 缺少注释 h 自动生成的JavaDoc注释

3、结构类问题

a do-while禁用引起的重复 b switch-case引起的长分支 c 莫名其妙的default d 被忽略的Exception e 全局变量做返回值
 f 不必要的Guard代码 g 嵌套过深 h 输出型参数 i 冗余的临时变量 j 不合理的错误号

4、架构类问题

a 关系混乱<循环引用、错误的继承、不当从属关系、大杂烩类> b 重复与类似 c 层层深入的private方法  d 墨守成规

5、风格类问题

a 长方法 b 长参数列表 c 长判定语句 d 长分支 e 魔法数字 f 字符串直接引用 g 冗余的常量定义 h 意思不明的逻辑 i 变量意思不稳定
 j 返回值意思不稳定 k 无用的方法或者变量 l 诡异代码

代码的可测试性问题：

1. 难以构建测试夹具

2. 难以拆分做单元测试

代码的可维护性问题：

需求变更难以应对

纠缠不清的BUG

时间： 2024-08-28 18:21:57

代码规范————代码问题总结1的相关文章

个人博客作业-Week2 (代码规范, 代码复审)

代码规范: 1.这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西. 编码规范它包含了代码格式,还包括了编码风格和其他规范,通常涉及:缩进.空格使用.Tab使用 注释.命题习惯.代码行长度和语言特点风格,从而使大家能够很方便得互相阅读对方的代码从而促进 团队中的沟通与交流.不是浪费时间. 2.我是个艺术家,手艺人,我有自己的规范和原则. 艺术家的表现层次如果只是在规范上面,显然不是个优秀的艺术家,通过大家都容易接受的方式可以 让自己的创造力更好得表现出来. 3.规

代码规范、代码复审、PSP

作业三: 代码规范.代码复审.PSP 代码规范 代码规范的重要性 一.规范的代码可以促进团队合作  一个项目大多都是由一个团队来完成,如果没有统一的代码规范,那么每个人的代码必定会风格迥异.且不说会存在多个人同时开发同一模块的情况,即使是分工十分明晰的,等到要整合代码的时候也有够头疼的了.大多数情况下,并非程序中有复杂的算法或是复杂的逻辑,而是去读别人的代码实在是一件痛苦的事情.统一的风格使得代码可读性大大提高了,人们看到任何一段代码都会觉得异常熟悉.显然的,规范的代码在团队的合作开发中是非常有

JavaScript代码规范和性能整理

性能 Js在性能方面有多要注意的地方: 避免全局查找 Js性能优化最重要的就是注意全局查找,因为作用域的查找是先找局部作用域在没有找到之后在去上一级作用域查找直到全局作用域,所以全局作用域查找的性能消耗肯定要比本函数局部作用域的消耗大.举个例子: function setInnerHtml(){ var divDom=doucument.getElementsByTagName("div"); for(var i=0,len=divDom.lemgth;i<len;i++){ d

JAVA技术开发规范（4）——JASMP平台的开发代码规范

4.关于代码规范 代码规范对程序员的重要性: 1.在软件开发生命周期中,有80%的时间是用在维护上 2.几乎所有的软件维护者都不是创使人 3.迭代式开发,必须要有清晰.可读性强的代码,以便于快速迭代 4.敏捷开发时,对应文档的输出不是减少,而是更加实用,因此,可交付的易读的代码更为重要了 5.协同协同,必需确保在编码时遵循统一的规范 编码规范是必需的,每个参与人必需严格遵循该规范进行编码. 4.1.命名规范 基本原则: 1.采用英文全称进行命名 2.保持各层级名称基本统一 3.命名英文单词用全称

蒟蒻的代码规范与文档编写规范

代码规范 代码每行不得超过 80 个字符: 代码不分块.连续编写,且每一个模块不允许超过 100 行: 双目运算符运算对象与运算符之间一定要分别打一个空格,单目运算符与运算对象之间不打空格: 禁止使用 Tab 缩进,使用 2 空格缩进代码. 宏定义时没有缩进. 基本使用 Java 代码风格,如果在 for.if 后只有一两个语句,尽量不使用大括号包围,如果一定要使用大括号,则尽量压行书写. 模块化的代码,提倡代码宽而短,不提倡瘦长的代码风格. 没有通用的头文件,随用随加. 尽量开局部变量,减少全

作业三: 代码规范、代码复审、PSP

(1) 是否需要有代码规范         1.这些规范都是官僚制度下产生的浪费大家的编程时间.影响人们开发效率, 浪费时间的东西.(反对) 答:首先编码规范 包括了编码风格和其它规范 一个团队遵守一些规范有很多的好处! (1). 遵守编码风格使代码更容易维护 (2). 编码风格使形成代码集体所有制(集体所有制的作用很大,它能有效的增大巴士因子——一个项目能承受多少个程序员被车撞了而不影响项目的正常进行) (3). 编码风格能消除那些长久的纷争(你不需要喜欢这种编码风格.如果你不喜欢里面的某条规

两人合作之代码规范

代码规范 现代软件经过几十年的发展,一个软件由一个人单枪匹马完成,已经很少见了,软件都是在相互合作中完成的.合作的最小单位是两个人,两个工程师在一起,做的最多的事情就是"看代码",每个人都能看"比人的代码",并且发表意见.但是每个人对于什么是"好"的代码规范未必认同,这时我们有必要给出一个基准线-----什么是好的代码规范和设计规范. 1,写干净整洁的代码 1.1 代码格式化,包括多级代码缩进.大括号(比如C系代码),为了提高代码的美观型和易读性

代码规范的重要性

一个规范的代码,通常能起到事半功倍的作用: 一.规范的代码可以促进团队合作 一个项目大多都是由一个团队来完成,如果没有统一的代码规范,那么每个人的代码必定会风格迥异.且不说会存在多个人同时开发同一模块的情况,即使是分工十分明晰的,等到要整合代码的时候也有够头疼的了.大多数情况下,并非程序中有复杂的算法或是复杂的逻辑,而是去读别人的代码实在是一件痛苦的事情.统一的风格使得代码可读性大大提高了,人们看到任何一段代码都会觉得异常熟悉.显然的,规范的代码在团队的合作开发中是非常有益而且必要的. 二.规范

最详细的 Swift 代码规范指南

1. 代码格式 1.1 使用四个空格进行缩进. 1.2 每行最多160个字符,这样可以避免一行过长. (Xcode->Preferences->Text Editing->Page guide at column: 设置成160即可) 1.3 确保每个文件结尾都有空白行. 1.4 确保每行都不以空白字符作为结尾 (Xcode->Preferences->Text Editing->Automatically trim trailing whitespace + Incl