java 函数命名_Java命名规范

1. 编码统一设置为UTF-8

2. 代码的组织与风格：

2.1 一个代码块的缩进统一为4个空格，使用Tab键，不是敲4下空格

2.2 空格：A.所有的二元运算符，除了“.”，应该使用空格将之与操作数分开。一元操作符和操作数之间不应该加空格，比如：负号(“-”)，自增(“++”)和自减(“--”)。

B.括号和它里面的字符之间不要出现空格。括号应该和它前边的关键词留有空格。

C．方法和左括号之间不要空格。

D．二元操作符和操作数之间要用空格隔开。

2.3 在方法、局部变量和后边的语句之间、方法内部的逻辑部分之间需要有一个空行，不要有多个空行，也不要没有空行。

2.4 一行代码的长度不要超过当前编辑页的宽度，也就是编辑页下方的左右拉动条不要出现。如果一行代码长度超过了当前编辑页的宽度(通常为表达式)，则需要换行，换行需要注意：

A) 在一个逗号后面断开。

B) 在一个操作符前面断开。

C) 新的一行应该与上一行同一级别表达式的开头处对齐。

2.5 每一个函数的有效代码(不包括注释和空行)不要超过50行,如果超过50行，则审视代码，可将一些功能性的代码单独提出，写成一个方法。

2.6 注释

2.6.1 保持注释的简洁，不是任何代码都需要注释的，过多的注释反而会影响代码的可读性。如果语句块(比如循环和条件分枝的代码块)代码太长，嵌套太多，则在其结束“｝”要加上注释，标志对应的开始语句。如果分支条件逻辑比较复杂，也要加上注释。

2.6.2 块注释：主要用来描述文件，类，方法，算法等，放在所描述对象的前边。

/**

*作者，创建日期，修改日期，描述内容

*/。

2.6.3 行注释：主要用在方法内部，对代码，变量，流程。整个注释占据一行。

2.6.4 尾随注释：与行注释功能相似，放在代码的同一行。

2.6.5 注释内容

项目

注释哪些部分

参数

参数用来做什么

任何约束或前提条件

字段/属性

字段描述

类

类的目的

已知的问题

类的开发/维护历史

接口

目的

它应如何被使用以及如何不被使用

局部变量

用处/目的

成员函数注释

成员函数做什么以及它为什么做这个

哪些参数必须传递给一个成员函数

成员函数返回什么

已知的问题

任何由某个成员函数抛出的异常

成员函数是如何改变对象的

包含任何修改代码的历史

如何在适当情况下调用成员函数的例子适用的前提条件和后置条件

成员函数内部注释

控制结构

代码做了些什么以及为什么这样做

局部变量

难或复杂的代码

处理顺序

2.6.6 程序修改注释

新增代码行的前后要有注释行说明，对具体格式不作要求，但必须包含作者，新增时间，新增目的。在新增代码的最后必须加上结束标志；

修改代码行建议以删除代码行后再新增代码行的方式进行(针对别人的代码进行修改时，必须标明，对于自己的代码进行修改时，酌情进行)。注释方法和内容同新增；

2.7    变量的声明，需要归类放置。

3 命名

3.1 命名的基本约定

3.1.1 使用可以准确说明变量/字段/类的完整的英文描述符，如firstName。对一些作用显而易见的变量可以采用简单的命名，如在循环里的递增(减)变量就可以被命名为i。

3.1.2 尽量采用项目所涉及领域的术语。

3.1.3 采用大小写混合，提高名字的可读性。为区分一个标识符中的多个单词，把标识符中的每个单词的首字母大写。不采用下划线作分隔字符的写法。有两种适合的书写方法。适用于不同类型的标识符：

PascalCasing:标识符的第一个单词首字母小写。

CamelCasing:标识符的第一个单词首字母大写。

标识符

大小写

示例

命名空间

Pascal

namespace Com.Techstar.ProductionCenter

类型

Pascal

public class DevsList

接口

Pascal

public interface ITableModel

方法

Pascal

public void UpdateData()

属性

Pascal

Public int Length{…}

事件

Pascal

public event EventHandler Changed;

私有字段

Camel

private string fieldName;

非私有字段

Pascal

public string FieldName；

枚举值

Pascal

FileMode{Append}

参数

Camel

public void UpdateData(string fieldName)

局部变量

Camel

string fieldName;

3.1.4 尽量避免使用缩写，使用时，需要保留标准缩写列表。两个字母的缩写要采用统一大小写的方式(ioStream,getIOStream)。多字母缩写采用首字母大写，其他字母小写的方式(GetHtmlTag)。

3.1.5 避免使用长名字。

3.1.6 避免使用相似或者仅在大小写上有却别的名字。

3.2 类和接口的命名

3.2.1 类的名字要用名词。

3.2.2 接口的名字要以I开头，保证其实现只和接口的名字差一个I字母。

3.2.3 方法命名：第一个单词一般为名词。

3.2.4 方法的重载规范：

A.如果重载中某个参数表示同一种输入，则要用相同的名字。

B.避免重载成员的参数顺序不一致，同名参数应该出现在相同位置。

C．要允许参数可为null

HTML、JS、java编码规范大同小异。

HTML编码规范

1. 小写所有字母。

2. 样式和脚本使用引用的方式。

3. 标签一定要有结束标记。

4. 属性值要用双引号，属性一律小写。

5. 标签要合理嵌套。

6. 图片中一定要有alt属性。

7. 属性中的width,height一律使用百分比。

8. 标签要有缩进，统一为4个空格，即一个Tab。

9. 需要有适当的注释。

10. 一个标记必须占据一行。不得出现两个标记出现在同一行的情况。

11. 最高一级采用左对齐顶格的方式书写。下一级采用左对齐向右缩进一个Tab的方式书写。

12. 同一级的标记必须上下对齐。

JavaScript编码规范

1. 所有变量必须声明。

2. 将var语句放在函数的首部。

3. 变量尽量采用小写，全局变量全部大写。

4. 右花括号后面必须跟随分号。

数据库编码规范

1. 表名单词首字母一律大写

2. 视图以VI_开头

3. 触发器以TRI_+触发器名称+_IUD(I为insert，U为update,D为delete)

4. 存储过程以P_开头

5. 注释格式为:

--===================

--功能

--作者

--时间

--返回值

--====================

开发过程中的文档要求

1. 需求文档(完整的)

2. 概要设计文档(完整的)

3. 详细设计文档(完整的)

4. 数据库设计文档，包括表说明，字段说明，触发器说明，存储过程说明，视图说明等。

5. 开发日志，项目经验。

格式为：时间，姓名，主题，解决方案。

6. 测试文档