命名规范

VBScript编码约定
常数命名约定
如果要使用常数，则常数以变量的方式实现，且全部字母大写以和其他变量区分。常数名中的多个单词用下划线 (_) 分隔。例如：
 USER_LIST_MAX
 NEW_LINE
这种标识常数的方法依旧可行，但您还可以选择其他方案，用 Const 语句创建真正的常数。这个约定使用大小写混合的格式，并以“con”作为常数名的前缀。例如：
 conYourOwnConstant
变量命名约定
为提高易读和一致性，请在 VBScript 代码中使用以下变量命名约定：
子类型 前缀 示例 
Boolean bln blnFound 
Byte byt bytRasterData 
Date (Time) dtm dtmStart 
Double dbl dblTolerance 
Error err errOrderNum 
Integer int intQuantity 
Long lng lngDistance 
Object obj objCurrent 
Single sng sngAverage 
String str strFirstName 

变量作用域
变量应定义在尽量小的作用域中。VBScript 变量的作用域如下所示：
作用域 声明变量处 可见性 
过程级 事件、函数或子过程。 在声明变量的过程中可见。 
Script 级 HTML 页面的 HEAD 部分，任何过程之外。 在脚本的所有过程中可见。 

变量作用域前缀
随着脚本代码长度的增加，有必要快速区分变量的作用域。在类型前缀前面添加一个单字符前缀可以实现这一点，而不致使变量名过长。
作用域 前缀 示例 
过程级 无 dblVelocity 
Script 级 s sblnCalcInProgress 

描述性变量名和过程名
变量名或过程名的主体应使用大小写混合格式，并且尽量完整地描述其目的。另外，过程名应以动词开始，例如 InitNameArray 或 CloseDialog。
对于经常使用的或较长的名称，推荐使用标准缩写以使名称保持在适当的长度内。通常多于 32 个字符的变量名会变得难以阅读。使用缩写时，应确保在整个脚本中保持一致。例如，在一个脚本或脚本集中随意切换 Cnt 和 Count 将造成混乱。
对象命名约定
下表列出了 VBScript 中可能用到的对象命名约定（推荐）：
对象类型 前缀 示例 
3D 面板 pnl pnlGroup 
动画按钮 ani aniMailBox 
复选框 chk chkReadOnly 
组合框、下拉列表框 cbo cboEnglish 
命令按钮 cmd cmdExit 
公共对话框 dlg dlgFileOpen 
框架 fra fraLanguage 
水平滚动条 hsb hsbVolume 
图像 img imgIcon 
标签 lbl lblHelpMessage 
直线 lin linVertical 
列表框 lst lstPolicyCodes 
旋钮 spn spnPages 
文本框 txt txtLastName 
垂直滚动条 vsb vsbRate 
滑块 sld sldScale 

代码注释约定
所有过程的开始部分都应有描述其功能的简要注释。这些注释并不描述细节信息（如何实现功能），这是因为细节有时要频繁更改。这样就可以避免不必要的注释维护工作以及错误的注释。细节信息由代码本身及必要的内部注释来描述。
当传递给过程的参数的用途不明显，或过程对参数的取值范围有要求时，应加以说明。如果过程改变了函数和变量的返回值（特别是通过参数引用来改变），也应在过程的开始部分描述该返回值。
过程开始部分的注释应包含以下区段标题。相关样例，请参阅后面的“格式化代码”部分。
区段标题 注释内容 
目的 过程的功能（不是实现功能的方法）。 
假设 其状态影响此过程的外部变量、控件或其他元素的列表。 
效果 过程对每个外部变量、控件或其他元素的影响效果的列表。 
输入 每个目的不明显的参数的解释。每个参数都应占据单独一行并有其内部注释。 
返回 返回值的解释。 

请记住以下几点：
每个重要的变量声明都应有内部注释，描述变量的用途。
应清楚地命名变量、控件和过程，仅在说明复杂细节时需要内部注释。
应在脚本的开始部分包含描述该脚本的概述，列举对象、过程、运算法则、对话框和其他系统从属物。有时一段描述运算法则的假码是很有用的。
格式化代码
应尽可能多地保留屏幕空间，但仍允许用代码格式反映逻辑结构和嵌套。以下为几点提示：
标准嵌套块应缩进 4 个空格。
过程的概述注释应缩进 1 个空格。
概述注释后的最高层语句应缩进 4 个空格，每一层嵌套块再缩进 4 个空格。例如：
'*********************************************************
' Purpose: Locates the first occurrence of a specified user
'          in the UserList array.
' Inputs: strUserList(): the list of users to be searched.
'         strTargetUser: the name of the user to search for.
' Returns: The index of the first occurrence of the strTargetUser
'          in the strUserList array.
'          If the target user is not found, return -1.
'*********************************************************
Function intFindUser (strUserList(), strTargetUser)
   Dim i   ' Loop counter.
   Dim blnFound   ' Target found flag
   intFindUser = -1
   i = 0   ' Initialize loop counter
   Do While i <= Ubound(strUserList) and Not blnFound
      If strUserList(i) = strTargetUser Then
         blnFound = True   ' Set flag to True
         intFindUser = i   ' Set return value to loop count
      End If
      i = i + 1   ' Increment loop counter
   Loop
End Function

Java编码规范
注释,
1,开头注释
/* 类名
 * 版本信息 日期 版权声明
 */
2,块(block)注释
/*
 * 提供对文件,方法,数据结构和算法的描述
 */
在功能和方法内部的块注释应该和他们所描述的代码具有一样的缩进格式.块注释之首应该有一个空行,用于把块注释和代码分割开来.
3,单行(single-line)注释
/* */
单行注释单独显示一行,并与其后的代码具有一样的缩进层级.如果一个注释不能在一行内写完,就应该采用块注释. 单行注释之首应该有一个空行,用于把单行注释和代码分割开来.
4,尾端(trailing)注释
极端的注释可以与它们所要描述的代码位于同一行,但是要有足够的空白来分开代码和注释.若有多个短注释出现于大断代码中,它们应该具有相同的缩进.
代码   /* 尾端注释 */
5,行末(end-of-line)注释
一般用来注释代码段.
//
6,文档注释
/**
 * 描述Java的类,接口,构造器,方法以及字段(field)
 */

空格的使用
1,一个紧跟着括号的关键字应该被空格分开
2,空白应该位于参数列表中的逗号的后面
3,所有的二元运算符应该用空格将之于操作数分开;一元操作符和操作数之间不应加空格
4,for语句中的表达式应该被空格分开
5,强制转型后应该跟一个空格

命名规范
1包:一个唯一的包名的前缀总是全部小写的ASCII字母,并且是一个顶级域名,包名的后续部分根据不同机构各自内部的命名规范而不尽相同.
2,类,接口:名词,大小写混合,首字母大写.
3,方法:动词,大小写混合,首字母小写.
4,常量:全部大写,单词间用下划线隔开.