zoukankan      html  css  js  c++  java
  • Java命名规范

    一、命名规范

    1、 项目名全部小写

    2、 包名全部小写

    3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。

    如:public class MyFirstClass{}

    4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。

    如:int index=0;

           public void toString(){}

    5、 常量名全部大写

    如:public static final String GAME_COLOR=”RED”;

    6、所有命名规则必须遵循以下规则:

    1)、名称只能由字母、数字、下划线、$符号组成

    2)、不能以数字开头

    3)、名称不能使用JAVA中的关键字。

    4)、坚决不允许出现中文及拼音命名。

    二、注释规范

    1、   类注释

    在每个类前面必须加上类注释,注释模板如下:

    /**

    * Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

    * FileName: Test.java

    * 类的详细说明

    *

    * @author 类创建者姓名
        * @Date    创建日期

    * @version 1.00

    */

    2、   属性注释

    在每个属性前面必须加上属性注释,注释模板如下:

    /** 提示信息 */

    private String strMsg = null;

    3、   方法注释

    在每个方法前面必须加上方法注释,注释模板如下:

    /**

    * 类方法的详细使用说明

    *

    * @param 参数1 参数1的使用说明

    * @return 返回结果的说明

    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    4、   构造方法注释

    在每个构造方法前面必须加上注释,注释模板如下:

    /**

    * 构造方法的详细使用说明

    *

    * @param 参数1 参数1的使用说明

    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    5、   方法内部注释

    在方法内部使用单行或者多行注释,该注释根据实际情况添加。

    如://背景颜色

           Color bgColor = Color.RED

  • 相关阅读:
    apache安全—用户访问控制
    hdu 3232 Crossing Rivers 过河(数学期望)
    HDU 5418 Victor and World (可重复走的TSP问题,状压dp)
    UVA 11020 Efficient Solutions (BST,Splay树)
    UVA 11922 Permutation Transformer (Splay树)
    HYSBZ 1208 宠物收养所 (Splay树)
    HYSBZ 1503 郁闷的出纳员 (Splay树)
    HDU 5416 CRB and Tree (技巧)
    HDU 5414 CRB and String (字符串,模拟)
    HDU 5410 CRB and His Birthday (01背包,完全背包,混合)
  • 原文地址:https://www.cnblogs.com/dnn179/p/java_name_standard.html
Copyright © 2011-2022 走看看