zoukankan      html  css  js  c++  java
  • 《团队-记事本程序-代码设计规范》

     快速入门

    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.        简单明了,确保任何程序员都可以读懂。

  • 相关阅读:
    android中的Cursor类
    设计模式之UML类图的常见关系(一)
    关于form 上传文件时的小问题
    Javascript中最常用的61段经典代码
    自我提升mysql
    为mysql在表的某一位置增加一列
    由<a>标签的onclick影出来的问题
    第一博客
    异常的出理
    2016.7.17内部类
  • 原文地址:https://www.cnblogs.com/lds18341211674/p/7601542.html
Copyright © 2011-2022 走看看