java程序命名规则

程序命名规则
提示&＃xff1a;模块设计人员确定本软件的模块命名规则&＃xff08;例如类、函数、变量等&＃xff09;&＃xff0c;确保模块设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用&＃xff08;如果存在的话&＃xff09;。
命名规则
1、包命名
    Java程序以包名为文件目录名&＃xff0c;通过包的分层结构实现对程序进行归类和模块化管理。包名要求全部用英文字母小写&＃xff0c;通过.进行分割&＃xff0c;建议在包名中体现公司名称或产品&＃xff08;项目&＃xff09;英文名简写&＃xff0c;通常为“公司名&＃43;产品&＃xff08;项目&＃xff09;名&＃43;模块名&＃43;子模块名”&＃xff0c;如&＃xff1a;ausware.apply.manage&＃xff08;ausware为公司英文名&＃xff0c;apply为产品名,manage为模块名&＃xff09;&＃xff0c;商业软件通常会以com.开头&＃xff0c;如&＃xff1a;com.sun.java.swing&＃xff08;com为通用前缀&＃xff0c;sun为公司名称&＃xff0c;java为产品名&＃xff0c;swing为模块名&＃xff09;&＃xff0c;是否加com不做强制要求。

2、类命名
    Java中类名统一要求用英文单词或组合&＃xff0c;可以用简写&＃xff0c;单词首字母要大写&＃xff0c;单词之间通过大写字母隔开。类名应该准确表达本类的作用&＃xff0c;通常为“模块名&＃43;功能名”结构&＃xff0c;如&＃xff1a;EngineManage&＃xff0c;DeviceAction。

3、类成员变量命名
    操作类成员变量要求以m_打头&＃xff1b;如果变量为全局变量&＃xff0c;以g_打头&＃xff1b;数据结构类成员不建议用m_开头。
    变量需要明确表达含义&＃xff0c;采用英文单词或组合&＃xff0c;可以用简写&＃xff0c;用大写字母隔开&＃xff0c;除了范围字母&＃xff0c;首字母小写。通常为“范围&＃43;类型&＃43;变量描述”&＃xff0c;其中常见的类型主要有&＃xff1a;map&＃xff08;表示映射集HashMap、Map&＃xff09;、vec&＃xff08;表示向量集Vector&＃xff09;、list&＃xff08;表示List&＃xff09;、b&＃xff08;表示boolean&＃xff09;、i&＃xff08;表示int&＃xff09;、str&＃xff08;表示String&＃xff0c;由于String类型在java中非常常用&＃xff0c;通常可以不用str开头&＃xff0c;以免累赘&＃xff09;、l&＃xff08;表示long&＃xff09;、c&＃xff08;表示char&＃xff09;、f&＃xff08;表示float&＃xff09;、d&＃xff08;表示double&＃xff09;。举例&＃xff1a;
操作类&＃xff1a;
public class EngineManage
{
  private static EngineManage  g_instance&＃61;null;  //全局
  private HashMap m_mapEngineContexts&＃61;new HashMap(); //成员
  private boolean m_bInitFlag &＃61; false;  //成员&＃xff0c;是否初始化标志
  public int m_iPort &＃61; 0;
  public long m_lSize &＃61; 0;
}
数据结构类&＃xff1a;
public class DeviceModel
{
  public String devNameAlias &＃61; null; //设备别名
  public String devName &＃61; null; //设备名称    
  public float fSize &＃61; 0;
  public double dWideSize &＃61; 0;
}

4、类成员函数命名
    类成员函数名需要表达出函数功能&＃xff0c;采用英文单词或组合&＃xff0c;可以用简写&＃xff0c;首字母小写&＃xff0c;中间单词的首字母要大写&＃xff0c;其余小写。第一个单词为动作&＃xff0c;后续单词为作用对象&＃xff0c;通常为&＃xff1a;“动作&＃43;对象名”&＃xff0c;举例&＃xff1a;createEngineContext&＃xff0c;addDevice。

5、函数参数名
    采用英文单词或组合&＃xff0c;可以用简写&＃xff0c;首字母小写&＃xff0c;中间单词采用大写字母隔开。不要用m_和g_开头。
    对于接口函数的参数名&＃xff0c;建议尽量明确表达出参数是输入、输出、输入及输出&＃xff0c;以及类型。输入通常用in&＃xff0c;输出通常用o&＃xff0c;输入输出通常用io&＃xff0c;举例&＃xff1a;   
   public long createEngineContext(String engineContextClassName,RefString oErrMsg);
  接口函数&＃xff1a;   
   public int retriveDatas (String inStrID ,Vector oVecDatas, RefString oErrMsg);
   // inStrID 中的in为输入&＃xff0c;Str为类型&＃xff0c;ID为变量描述&＃xff1b;
   // oVecDatas 中的o为输出&＃xff0c;Vec为类型&＃xff0c;Datas为变量描述&＃xff1b;
   //oErrMsg中的o为输出&＃xff0c;ErrMsg为变量描述。

6、函数内部变量名
    原则上除了计数变量i,n,k,j等&＃xff0c;都应该采用英文单词或组合表达明确含义&＃xff0c;可以用简写&＃xff0c;不要用m_和g_等开头。普通变量通常为“类型&＃43;变量描述”&＃xff1b;对复合自定义对象的命名可以直接用对象名&＃xff0c;把首字母改为小写&＃xff1b;需要返回的变量建议加上ret前缀&＃xff1b;临时变量建议加上tmp前缀。举例&＃xff1a;
  for(int i; i<10; i&＃43;&＃43;)&＃xff1b; //计数变量
  boolean bSearchFlag;  //以类型为前缀
  int iSize;  
  long lWidth;
  String strDevName; //带String类型前缀str  
  String devName;   //不带String类型前缀&＃xff0c;因String非常常用可以省略
  EngineContext engineContext &＃61; null; //复合自定义对象&＃xff0c;用类型名&＃xff0c;把首字母改为小写
  EngineContext tmpEngineContext &＃61; null; //带临时变量tmp前缀
  EngineContext retEngineContext &＃61; null;  //带返回变量前缀ret    

7、常量名
    常量名采用大写单词或以下划线_组合多个单词&＃xff0c;明确表达含义&＃xff0c;如&＃xff1a;
    public final static String YES &＃61; "yes";
    public final static int DEBUG_ERROR &＃61; 2;  //记录出错信息
    public final static String SYSLOG_PROCESS_NAME &＃61; "SYSLOG";