团队-记事本程序-代码设计规范

l  驼峰式命名(大小写交替)

错误:

public classmyClass

publicinterface foo

public finalstatic int max = 100

public intFooValue

正确:

public classMyClass

publicinterface IFoo

public finalstatic int MAX = 100

public intfooValue

l  使用Javadoc识别的注释

在函数声明前添加注释(输入”/**”+回车)

l  精简函数体(最好不要超过40行)

l  局部变量随用随声明(尽量缩小变量的作用域)

l  每行最长100字符

l  缩进用4个空格代替TAB

l  成员变量名用m开头,static变量名用s开头

l  前大括号“{”不要单占一行

错误:

if(condition)

{

//dosomething

}

正确:

if(condition) {

//do something

}

l  多利用标准注解

错误:

publicvoidonCreate(Bundle savedInstanceState) {

正确:

@Override

publicvoidonCreate(Bundle savedInstanceState) {

l  少用不常见缩写

错误:opnDlg

正确:openDialog

命名

A.  Java命名规范

命名应符合驼峰式规则,利用大小写字母交替来区分名称中的不同单词,即应采用小写字母,但类名、接口名以及任何非初始单词的第一个字母要大写。

1.        尽量使用完整的英文描述符,采用适用于该领域的术语

2.        采用大小写混合使名字可读

3.        尽量少用缩写,但如果用了,要明智地使用。

4.        避免使用类似的名字,或者仅仅是大小写不同的名字

四、     注释

1.        每个类必须有文件头注释。简要说明类的作用,注明作者和创建时间。标准模板:

/**

* Filedescription.

*

* @author ${USER}

* @date ${DATE}

*/

2.        大部分方法都需要方法注释,一些不言自明的方法除外。简要说明方法作用,并解释参数、返回值、抛出异常。方法注释请使用JavaDoc标准。例如:

/**

* Description.

*

* @param arg1 description

* @param arg2 description

* @return description

* @throws Exception description

*/

public int getFoo(int arg1, booleanarg2) throws Exception {

return 0;

}

3.        关键逻辑或者较复杂的逻辑处,应该添加必要的注释。单行注释使用”//”,多行注释使用/**/。

4.        注释必须在程序改变时实时更新。

5.        简单明了,确保任何程序员都可以读懂

队长博文地址:http://www.cnblogs.com/lds18341211674/p/7601542.html

时间: 2024-09-30 14:35:50

团队-记事本程序-代码设计规范的相关文章

《团队-记事本程序-代码设计规范》

l  驼峰式命名(大小写交替) 错误: public classmyClass publicinterface foo public finalstatic int max = 100 public intFooValue 正确: public classMyClass publicinterface IFoo public finalstatic int MAX = 100 public intfooValue l  使用Javadoc识别的注释 在函数声明前添加注释(输入"/**"

团队-象棋游戏-代码设计规范

逆流而上 象棋游戏 代码规范 一.前言: 本编程规范适用于编写HTML/CSS代码,本规范并不是一个一成不变的必须严格遵守的条文,特殊情况下应灵活应对,做到变通. 二.HTML编码: HTML是一种标记语言,HTML没有任何真正的编程语言中的循环或是流程控制语句.然而,HTML代码的格式和风格是非常重要的,因为要经常对HTML代码进行维护和修改,因此HTML代码必须有很清晰的逻辑结构和布局,增强可读性,而使其易懂和易于维护.HTML代码本身是不区分大小写的,但是为了更好的统一代码布局,本项目中H

《团队-科学计算器-代码设计规范》

代码布局设计 缩进 1.Tab实现 2.空格实现 字符串: 1.单引号 2.双引号 3.避免反斜杠的出现.   1 .变量名称 在写变量的时候,尽量避免小写的l和大写字母O和大写字母I,主要原因是容易和数字中1,0相混淆 2 .包和模块名称 模块尽量使用简短的全部小写的名称,如果可以增加可读性那么可以使用下划线,python的包不推荐使用下划线,但是在引用其他语言写的扩展包中可以使用下划线来表示区分 3 .类名称 类名称主要遵循为CapWords约定,表示为首字母大写 4.异常名称 异常归于类,

团队-科学计算器-代码设计规范

1.代码布局设计 缩进 1.Tab实现 2.空格实现 字符串: 1.单引号 2.双引号 3.避免反斜杠的出现. 2.资源Res 1.按照类型,分为以下几种 控件Id命名:控件缩写 _模块(module) _功能名(function) 2.Color命名 Resources Type 命名规则 color 组件名+具体作用名.例 R.color.button_text 3.String命名 Resources Type 命名规则 string 具体功能. 例 R.string.hello 4.Dr

团队编程项目代码设计规范(爬取豆瓣电影top250)

队长博客链接:http://www.cnblogs.com/nullblogs/p/7612883.html 基本格式 缩进 使用4个空格进行缩进 行宽 每行代码尽量不超过80个字符 理由: 这在查看side-by-side的diff时很有帮助 方便在控制台下查看代码 太长可能是设计有缺陷 换行 Python支持括号内的换行.这时有两种情况. 第二行缩进到括号的起始处 foo = long_function_name(var_one, var_two, var_three, var_four)

团队编程项目作业2-团队编程项目代码设计规范

代码设计规范 其中有一些强制性的重要的原则:首先就是字符串的拼加操作,必须使用StringBuilder,其次就是关于try-catch的一些用法 1.基本原则 1.对于捕获后,不知道干什么事情或者也不知道怎样处理的情况,就不要捕获异常,留给外出层去捕获处理:     2.返回类型为集合的,在方法声明中必须使用泛型,必须在javadoc中注明什么情况下返回null,什么情况下返回空集合.     3.对于方法.变量声明范围要采用如下优先级:private.protected.public,对于变

团队编程项目作业2-爬虫豆瓣top250项目代码设计规范

来自队长http://www.cnblogs.com/z-xx/p/7592127.html 一.程序风格: 1.严格采用阶梯层次祖师程序代码 各层次锁紧的分割采用VC的缺省风格 , 即没层次锁紧为4格.括号位于下一行.要求相匹配的大括号在同一列 ,对继行则要求在缩进4格. 2.对变量的定义.尽量位于函数的开始位置. 二.命名规则: 1.变量名的命名规则 1).变量命名规则要求用"匈牙利法则".即抬头字母用变量的类型,其余部分用变量的英文意思或者其英文意思的缩进,尽量避免用中文的拼音,

编写高质量JAVA程序代码的建议

--------------------------------------------------------------------------------------------------- 前言:原著<改善JAVA程序的151个建议>有151个建议,我在拜读的过程根据自己的理解合并了其中的几个,并将每个建议的核心要义进行了一次纯手工提炼,以方便想阅读这本书的同行能够更快的掌握这本书的所有核心内容. -------------------------------------------

代码质量优先——《编写高质量代码:改善c程序代码的125个建议》

高质量的代码不但可以促进团队合作.减少bug处理.降低维护成本,对程序员自身的成长也是至关重要的.很难想象一个参考<如何编写无法维护的代码>写代码的程序员技术成长的上限有多么低.为了写出高质量的代码,我们需要听取过来人的改善代码质量的经验,<编写高质量代码:改善c程序代码的125个建议>就是一本能让人写出高质量代码的好书. 本书的第三章<程序控制语句应该保持简洁高效>首先用简练的语言介绍了流程控制结构的概念,然后提供了对if.else.for.do-while.swit