精华内容
下载资源
问答
  • java代码注释规范引(阿里巴巴开发规范-注释规约)结合注释规约,在IDEA下设置相应的注释模板1,安装阿里巴巴开发规约的IDEA提示插件,这样能够在很大程度上规范自己的编程规范,在出现代码编写风格不规范的情况下会...

    引(阿里巴巴开发规范-注释规约)

    1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范,使用/*内容/格式,不得使用
      // xxx 方式。
      说明:在 IDE 编辑窗口中,Javadoc 方式会提示相关注释,生成 Javadoc 可以正确输出相应注
      释;在 IDE 中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高
      阅读效率。
    2. 【强制】所有的抽象方法(包括接口中的方法)必须要用 Javadoc 注释、除了返回值、参数、
      异常说明外,还必须指出该方法做什么事情,实现什么功能。
      说明:对子类的实现要求,或者调用注意事项,请一并说明。
    3. 【强制】所有的类都必须添加创建者和创建日期。
    4. 【强制】方法内部单行注释,在被注释语句上方另起一行,使用//注释。方法内部多行注释
      使用/* */注释,注意与代码对齐。
    5. 【强制】所有的枚举类型字段必须要有注释,说明每个数据项的用途。
    6. 【推荐】与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持
      英文原文即可。
      反例:“TCP 连接超时”解释成“传输控制协议连接超时”,理解反而费脑筋。
    7. 【推荐】代码修改的同时,注释也要进行相应的修改,尤其是参数、返回值、异常、核心逻辑
      等的修改。
      说明:代码与注释更新不同步,就像路网与导航软件更新不同步一样,如果导航软件严重滞后,
      就失去了导航的意义。
    8. 【参考】谨慎注释掉代码。在上方详细说明,而不是简单地注释掉。如果无用,则删除。
      说明:代码被注释掉有两种可能性:1)后续会恢复此段代码逻辑。2)永久不用。前者如果没
      有备注信息,难以知晓注释动机。后者建议直接删掉(代码仓库保存了历史代码)。
    9. 【参考】对于注释的要求:第一、能够准确反应设计思想和代码逻辑;第二、能够描述业务含
      义,使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同
      天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路;注释也是给继任者看
      的,使其能够快速接替自己的工作。
    10. 【参考】好的命名、代码结构是自解释的,注释力求精简准确、表达到位。避免出现注释的
      一个极端:过多过滥的注释,代码的逻辑一旦修改,修改注释是相当大的负担。
      反例:
      // put elephant into fridge
      put(elephant, fridge);
      方法名 put,加上两个有意义的变量名 elephant 和 fridge,已经说明了这是在干什么,语
      义清晰的代码不需要额外的注释。
    11. 【参考】特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描,
      经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。
      1) 待办事宜(TODO):( 标记人,标记时间,[预计处理时间])
      表示需要实现,但目前还未实现的功能。这实际上是一个 Javadoc 的标签,目前的 Javadoc
      还没有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个 Javadoc 标签)。
      2) 错误,不能工作(FIXME):(标记人,标记时间,[预计处理时间])
      在注释中用 FIXME 标记某代码是错误的,而且不能工作,需要及时纠正的情况。

    结合注释规约,在IDEA下设置相应的注释模板

    1,安装阿里巴巴开发规约的IDEA提示插件,这样能够在很大程度上规范自己的编程规范,在出现代码编写风格不规范的情况下会给出相应的提示及建议:

    在这里插入图片描述

    2,安装JavaDoc在IntelljIDEA下的插件,可以单个或批量生成代码注释:

    插件安装:
    在这里插入图片描述
    安装完成后再IDEA中即可通过快捷键:Alt+Insert 生成代码javadoc的注释:
    在这里插入图片描述
    缺点是:由该插件生成的代码注释风格无法进行修改,所以在类的注释上也就无法添加author及create time的标志性字段,这与《阿里巴巴开发规约》的第3条相违背,但是在看dubbo或者其它阿里系产品的时候,发现他们自己开发的代码中类的注释也是采用的类似javadoc的插件自动生成的注释,类上面也没有加类似的标志性字段,自己也没有遵守相应的规范?
    在这里插入图片描述

    3,利用Live Template手动添加注释模版

    还记得在idea中使用sout,编辑器会自动提示是否为System.out.println();的功能,这里就是类似这样的实现。
    在Live templates中点击右侧的+号,选择第二项TemplateGroup,创建一个模板分组,而后在该分组下同样点击右侧的+号,这次选择第一项LiveTemplate。
    在这里插入图片描述
    这个名称尽量选择短一点,这其实就涉及到一个快捷键的问题,当输入cc的时候,就会自动生成类的注释,注释模板就采用阿里建议的模板风格:

    	/**
    	 *TODO:
    	 *
    	 *@author xxxx
    	 *@date $date$
    	 */
    

    在这里插入图片描述
    当编写完类需要完成什么功能后需要将TODO字样去掉,合乎《规范》第11.1的规定。

    综述:对于类注释采用liveTemplate配置注释模板,对于方法及字段注释采用javadoc插件自动生成的注释字样已完全够用,满足相应的需求。

    在这里插入图片描述

    附:IDEA生成javadoc的操作:

    在Tool中直接点击generate javaDoc,然后选择需要生成的项目及生成位置即可:
    在这里插入图片描述

    展开全文
  • 代码注释

    2010-08-14 02:56:00
     我C++3年,C 3年,偶尔也下java,读书的时候是c++,工作后越来越C,原因这里就不争论了,下面针对的是C语言来阐述可能会需要写注释的地方。 1:模块接口。 2:结构流程。 3:未完善或未来需求的分支。 

         今天在CSDN上 看到这样一篇文章<<程序员要避免的五种程序注释方式 >> (http://news.csdn.net/a/20100813/278141.html)看来后有些感想。大部分同学都坚持认为要写注释,但我写了几年后发现真正需要注释来帮助理解程序的地方是不是我们组织代码有问题呢?

        我用C++3年,用C 3年,偶尔也用下java,读书的时候用是c++,工作后越来越用C,原因这里就不争论了,下面针对的是C语言来阐述可能会需要写注释的地方。

        1:模块接口。

        2:结构流程。

        3:未完善或未来需求的分支。

        4:核心算法。

    也许还有,有些有交叉,我来一个个的分析为什么不需要或最少量的注释。

     

    一:模块接口:模块接口是要求越少越好的注释,最好是0注释。原因有

    1:请你用比注释更足以说明接口的函数或结构体作用的来命名,这样别人一看就知道,不需要看恼人的注释,我们发现大多数在版本升级中保留下的都是这样的接口。如果很偏,请考虑是否应该作为接口来公开给用户,思考自己的代码设计,有没有过度设计和给用户过大的使用自由度,因为适当的限制有利于控制bug,而不是一味的写注释。

    2:参数,如果我看到参数类型的详细的说明注释,我们也得思考,连自己都要注释才能记得参数意义的函数参数我们是否值得把它公开给用户。

    例如 int type类的参数,是否可以考虑用enum来枚举各个值的意义而代替恼人的注释呢?

    3:过多的参数表明你的接口过于的繁杂,违背了kiss原则,是否可以考虑简单的接口参数呢?用简单代替注释,有助于大家写更清晰的模块接口,使得你的用户使用你的代码轻松愉快。相信我简单的接口往往是稳定的代码的最重要的特征。

    4:过于生僻的函数参数是否意味着你的接口造了新的需要用户理解的概念,?能否拿掉减少用户的负担,使得使用更直观呢?

     

    二 结构流程:

        我们在写一个项目的工作机制的时候,比如媒体播放器,大家注释的地方都是数据经过的流程,结构的流程,其实当你在写注释的时候你长长的结构流程能够符合kiss 原则,有利于代码的稳定性吗?以mplayer的main函数为例,我想即使作者有详细的注释,我们看其来也很麻烦,那个main函数长的令人恐怖,如果还加上恼人的注释,我想没有人有勇气把这个函数看完。

        当我们面对复杂的流程,较长的流程需要写注释的时候我们应该思考,是否我们的函数太长了,这个时候你把函数名作为你最好的注释,把长长的函数换成100行以内的函数吧,这样,你还需要注释吗?你的结构只会分层的清晰,长长的给你切分的非常合理。

    三 未完善的未来的需求:

       对于未完善的未来的需求我想大家更不应该写注释,对于未完善的分支,用assert(1==0),对于未来的需求,大家大可放心的删掉,不做一点的过度设计,如果不能满足未来需求,重写就是了,而我们的短小精悍的函数块,在下次重写中总是可以被复用,对于复用我认为不是复用框架,而是复用里面稳定的小函数块。因为框架的复用几乎是过度设计的开始。这个就是用C的风格组织代码。

     这样我们还需要注释吗?

    四 核心算法:

       如果是一个核心算法的话,比如条码识别核心算法,对不起,这个时候更加不用写注释,原因有下面的状况:

       1:一个核心算法的高手是不需要看注释来修改代码的,他面对的是核心的算法,而不是维护代码,他的思路会天马行空,改动会很大,才能达到最优的,而以前过时的都会被无穷的丢掉,以至于回头看他以前写的,都看不懂,但那些算法都以过时还有什么用呢?所以核心算法不需写注释的理由一应该是没有人反对的吧。

       2:如果是核心算法,说真的,能称上核心的,能做到核心的都是高级程序员工作比较稳定,他们根本不需要注释。因为代码都是他自己来维护

       3:核心算法涉及的bug并不如用户UI等那些多种操作来的多。写完稳定,几乎很难有bug,因为bug是与算法有关,很难有语言因素造成。

     

    五,干净排列整齐的代码让人能愉快的工作,五颜六色的代码+注释,只会使得心情糟糕,这个还不说中国同学的蹩脚的英文注释。

     

    让注释不成为复杂设计的理解手段,因为你要相信这个设计本身就有问题。

     

     

    展开全文
  • Java代码注释规范

    2017-12-05 11:07:15
    Java代码注释规范

    Java代码注释规范

    一、   规范存在的意义

    应用编码规范对于软件本身和软件开发人员而言尤为重要,有以下几个原因:

    1、好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护;

    2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码;

    3、好的编码规范可以最大限度的提高团队开发的合作效率;

    4、长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维;

    二、命名规范

        1、一般概念

    1、尽量使用完整的英文描述符
            2、采用适用于相关领域的术语
            3、采用大小写混合使名字可读
            4、尽量少用缩写,但如果用了,必须符合整个工程中的统一定义
            5、避免使用长的名字(小于 15 个字母为正常选择)
            6、避免使用类似的名字,或者仅仅是大小写不同的名字
            7、避免使用下划线(除静态常量等)
    2、标识符类型说明

    1、包(Package )的命名
                Package 的名字应该采用完整的英文描述符,都是由一个小写单词组成。并且包名的前缀总是一个顶级域名,通常是comedugovmilnetorg 等;
                如: com.yjhmily.test

    2、类( Class )的命名
                类名应该是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量保证类名简洁而富于描述。使用完整单词,避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用,像 URL  HTML)
            
    如: FileDescription

    3、接口( Interface )的命名
                基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上,保证开头第一个字母为 ”I”,便于与普通的 Class区别开。其实现类名称取接口名的第二个字母到最后,且满足类名的命名规范;
            如: IMenuEngine

    4、枚举( Enum )的命名
                基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上,保证开头第一个字母为 ”E” ,便于与普通的 Class区别开。
            如: EUserRole

    5、异常( Exception )的命名
                异常( Exception )通常采用字母 e 表示异常,对于自定义的异常类,其后缀必须为 Exception
            
    如: BusinessException

    6、方法( Method )的命名
                方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”“ has ”来开头
            如: getCurrentUser()  addUser()  hasAuthority()

    7、参数( Param )的命名
                第一个单词的首字母小写,其后单词的首字母大写。参数量名不允许以下划线或美元符号开头,虽然这在语法上是允许的。参数名应简短且富于描述。
            如: public UserContext getLoginUser(String loginName);

    8、常量字段( Constants )的命名
               静态常量字段( static final )全部采用大写字母,单词之间用下划线分隔;
            如: public static final Long FEEDBACK;
                   public static Long USER_STATUS;

    三、注释规范

    一个很好的可遵循的有关注释的经验法则是:
                问问你自己,你如果从未见过这段代码,要在合理的时间内有效地明白这段代码,你需要一些什么信息???

    1、             一般概念

                1、注释应该增加代码的清晰度
                2、保持注释的简洁
                3、在写代码之前或同时写注释
                4、注释出为什么做了一些事,而不仅仅是做了什么

    2、             注释哪些部分

    1Java 文件:必须写明版权信息以及该文件的创建时间和作者;
                2、类:类的目的、即类所完成的功能,以及该类创建的时间和作者名称;多人一次编辑或修改同一个类时,应在作者名称处出现多人的名称;
                3、接口:在满足类注释的基础之上,接口注释应该包含设置接口的目的、它应如何被使用以及如何不被使用。在接口注释清楚的前提下对应的实现类可以不加注释;
                4、方法注释:对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索;
                5、方法内部注释:控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释;
                6、参数:参数含义、及其它任何约束或前提条件;
                7、属性:字段描述;
                8、局部 ( 中间 ) 变量:无特别意义的情况下不加注释;
            3、注释格式
               遵循工程规定的统一注释格式,一般情况下会以 codetemplates.xml 格式的文件导入 IDE(Eclipse)或者用Eclipse默认的;

    四、代码格式规范
        遵循工程规定的统一代码格式,一般情况下直接使用 IDE(Eclipse) 自带的默认代码格式对代码进行格式化;

    1、单行(single-line)--短注释://……    
    单独行注释:在代码中单起一行注释, 注释前最好有一行空行,并与其后的代码具有一样的缩进层级。如果单行无法完成,则应采用块注释。 
    注释格式:/* 
    注释内容 */ 
    行头注释:在代码行的开头进行注释。主要为了使该行代码失去意义。 
    注释格式:// 
    注释内容 
    行尾注释:尾端(trailing)--极短的注释,在代码行的行尾进行注释。一般与代码行后空8(至少4)个格,所有注释必须对齐。 
    注释格式:代码 + 8(至少4)个空格 + // 注释内容

    2、块(block)--块注释:/*……*/ 
    注释若干行,通常用于提供文件、方法、数据结构等的意义与用途的说明,或者算法的描述。一般位于一个文件或者一个方法的前面,起到引导的作用,也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成: 
    /* 
    注释内容 
    */

    3、文档注释:/**……*/

    注释若干行,并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/之中,注释文档将用来生成HTML格式的代码报告,所以注释文档必须书写在类、域、构造函数、方法,以及字段(field)定义之前。注释文档由两部分组成——描述、块标记。注释文档的格式如下:

    /**
    * The doGet method of the servlet. 
    * This method is called when a form has its tag value method 
     * equals to get. 
    * @param request 
    *  the request send by the client to the server 
    * @param response 
    *  the response send by the server to the client 
    * @throws ServletException 
    *  if an error occurred 
    * @throws IOException 
    *  if an error occurred 
    */

    public void doGet(HttpServletRequest request, HttpServletResponse response) 
    throws ServletException, IOException { 
        doPost(request, response); 

    前两行为描述,描述完毕后,由@符号起头为块标记注释。更多有关文档注 
    释和javadoc的详细资料,参见javadoc的主页: http://java.sun.com/javadoc/index.html

    4javadoc注释标签语法 
    @author    
    对类的说明标明开发该类模块的作者 
    @version   
    对类的说明标明该类模块的版本 
    @see      
    对类、属性、方法的说明参考转向,也就是相关主题 
    @param    
    对方法的说明对方法中某参数的说明 
    @return    
    对方法的说明对方法返回值的说明 
    @exception  
    对方法的说明对方法可能抛出的异常进行说明

    五、JAVA注释具体实现
    1、源文件注释 
    源文件注释采用 /** …… */,在每个源文件的头部要有必要的注释信息,包括:文件名;文件编号;版本号;作者;创建时间;文件描述包括本文件历史修改记录等。中文注释模版: 
    /** 
     : 
    * CopyRright (c) 2008-xxxx: 
    文件编号:
     
    人:
     
        期:
     
    人:
     
       期:
     
       述:
     
    号:
     
    */

    2、类(模块)注释:
    类(模块)注释采用 /** …… */,在每个类(模块)的头部要有必要的注释信息,包括:工程名;类(模块)编号;命名空间;类可以运行的JDK版本;版本号;作者;创建时间;类(模块)功能描述(如功能、主要算法、内部各部分之间的关系、该类与其类的关系等,必要时还要有一些如特别的软硬件要求等说明);主要函数或过程清单及本类(模块)历史修改记录等。 
    英文注释模版:

    /**
    * CopyRright (c)2008-xxxx:   <
    展望软件
    Forsoft>                         
    *Project:                    <
    项目工程名
    >                                         
    * Module ID:   <(
    模块)类编号,可以引用系统设计中的类编号
    >    
     * Comments:  <
    对此类的描述,可以引用系统设计中的描述
    >        
    * JDK version used:     <JDK1.6>                             
    * Namespace:           <
    命名空间
    >                             
    * Author
            <作者中文名或拼音缩写
    >                
    * Create Date
      <创建日期,格式
    :YYYY-MM-DD> 
    * Modified By
       <修改人中文名或拼音缩写
    >                                        
    * Modified Date:  <
    修改日期,格式
    :YYYY-MM-DD>                                   
    * Why & What is modified  <
    修改原因描述
    >   
    * Version:                 <
    版本号
    >                      
    */ 

    如果模块只进行部分少量代码的修改时,则每次修改须添加以下注释: 
    //Rewriter 
    //Rewrite Date
    <修改日期:格式YYYY-MM-DD>Start1 
    /* 
    原代码内容
    */ 
    //End1

    将原代码内容注释掉,然后添加新代码使用以下注释: 
    //Added by 
    //Add date
    <添加日期,格式:YYYY-MM-DD> Start2 
    //End2

    如果模块输入输出参数或功能结构有较大修改,则每次修改必须添加以下 
    注释: 
    //Log ID
    <Log编号,1开始一次增加>
    //Depiction
    <对此修改的描述

    //Writer
    :修改者中文名
     
    //Rewrite Date
    <模块修改日期,格式:
    YYYY-MM-DD> 
    3
    、接口注释:
    接口注释采用 /** …… */,在满足类注释的基础之上,接口注释应该包含描述接口的目的、它应如何被使用以及如何不被使用,块标记部分必须注明作者和版本。在接口注释清楚的前提下对应的实现类可以不加注释。

    4、构造函数注释:
    构造函数注释采用 /** …… */,描述部分注明构造函数的作用,不一定有块标记部分。 
    注释模版一: 
    /** 
    默认构造函数 
    */ 
    注释模版二:
     
    /** 
    * Description :       
    带参数构造函数
    *                      
    初始化模式名,名称和数据源类型
     
    * @param schema
       模式名
     
    * @param name
       名称
     
    * @param type
    数据源类型
     
    */ 
    5
    、函数注释:
    函数注释采用/** ……*/,在每个函数或者过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等。函数注释里面可以不出现版本号(@version)。 
    注释模版一: 
    /** 
      * 
     : 
      * 
    功能描述:
     
    输入参数:     <按照参数定义顺序

    *            <@param
    后面空格后跟着参数的变量名字
     
    *            
    (不是类型),空格后跟着对该参数的描述。


    :  - 类型 <说明
    >
    *            <
    返回为空(void)的构造函数或者函数,
     
    *            @return
    可以省略;如果返回值就是输入参数,必须

    *           用与输入参数的@param相同的描述信息必要的时

    *           候注明特殊条件写的返回值。
        常:<按照异常名字的字母顺序


        


        

    */ 
    注释模版二:
     
    /** 
    * FunName:          getFirstSpell 
    * Description :      
    获取汉字拼音首字母的字符串, 
    *                  
    被生成百家姓函数调用
     
    * @param
             str theString是包含汉字的字符串
     
    * @return String
    :汉字返回拼音首字母字符串;
     
    *                 
    英文字母返回对应的大写字母;
     
    *                
    其他非简体汉字返回 '0'
     
    * @Author:       ghc 
    * @Create Date: 2008-07-02 
    */ 
    6
    、方法注释:
    方法注释采用/** …… */,对于设置 (Set 方法 ) 与获取 (Get 方法 ) 成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建时间必须注释清楚,为将来的维护和阅读提供宝贵线索。 
    7
    、方法内部注释:
    控制结构,代码做了些什么以及为什么这样做,处理顺序等,特别是复杂的逻辑处理部分,要尽可能的给出详细的注释。 
    8
    、全局变量注释:
    要有较详细的注释,包括对其功能、取值范围、哪些函数或者过程存取以及存取时注意事项等的说明。 
    9
    、局部(中间)变量注释:
    主要变量必须有注释,无特别意义的情况下可以不加注释。 
    10
    、实参/参数注释:
    参数含义、及其它任何约束或前提条件。 
    11
    、字段/属性注释:字段描述,属性说明。 
    12
    、常量:常量通常具有一定的实际意义,要定义相应说明。

     

     

    myeclipse的注释相关

    1.对java文件的自动注释

    Window->Preference->Java -> Code Style -> CodeTemplates

    files:新建文件时的注释

    Types:类的注视

    Field:变量的注释

    Constructors:构造函数的注释

    methods:一般方法的注释

    可以在里edit一些固定的格式或变量 其中user默认取操作系统的名称,可以写死。日期格式俺想知道怎么改成yyyy-mm-dd

    2.对JSP文件的注释

    Window->Preference-myeclipse-editors-JSP-JSPTEMPLATES

     3.在java中用的一些快捷 例:sysout

    Window->Preference-java-editor-templates

    可以自己写一些参数~例如 user ---zhongjb

     

    六、工程特有命名规范
    1、持久层

                1 Hibernate 映射文件及实体
                   与数据库表名称完全对应;
                    如: Advertisement.hbm.xml  Advertisement.java

                2
    、数据访问 DAO
                   DAO 接口和实现类名称必须完全符合正常接口和实现类的命名规则,且最后以 ”DAO” 结尾。DAO 内的数据访问方法必须足够抽象的描述出对数据库的基本 CRUD 操作;
                    如: ICrossAdDAO( 接口 )  CrossAdDAO( 实现类 )


                3、各种操作数据库的 HQL 配置文件
                   HQL 文件的个数原则上与系统的 Services 层的服务个数相等,且以服务名称命名 HQL 文件;
                    如: resource.hbm.xml

           
    2、服务层
               1、服务接口和实现
                   服务接口和实现类必须完全符合正常接口和实现类的命名规则;以工程定义的服务名为主体,并统一以”Serv” 结尾
                    如: IResourceServ( 服务接口 )  ResourceServ( 接口实现类 )


                2、服务接口方法
                   方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。
               方法名尽可能的描述出该方法的动作行为。
                    返回类型为 Boolean 值:用“ is ”“ has ”来开头
                    得到某数据: get+ 数据描述名词复数 + 数据类型;
                    得到所有数据: get+All+ 数据描述名词复数 + 数据类型;
                    通过 XXX 得到 / 查询某数据: get/query+ 数据描述名词复数 + 数据类型 +By+ 条件;
                    添加某数据: save/add+ 数据描述名词 ()
                    
    更新某数据: save/update+ 数据描述名词;
                    删除某数据: delete/remove+ 数据描述名词;


                3、业务对象
                    业务名称 +BO
                4
    、查询参数对象
                   凡是继承 Abst***QuerySpec 的查询参数类全部满足以下规则:
                   Query+ 所要查询的数据描述名词+Spec
                    
    作为参数传入时,参数名必须为:所要查询的数据描述名词 +Spec
                    
    如: QueryProgramSpec
           
    3MVC            
               1
    Action 控制层
                   Action 类名:功能模块名称+Action 
                   Actoin 方法名称尽可能的描述出页面迁移的去向
                    如: LoginAction( 登录用 action)  toWelcome( 转向欢迎页的 action 方法 )

                2
    、资源文件
                    系统全局资源文件: globalMessages_+ 字符编码类型 +.properties
                    
    功能模块内部的资源文件: package.properties

      4、Spring 配置文件
                1、Action 相关配置文件
            文件目录: WebRoot/WEB-INF/spring/action/ 功能模块名称+_ApplicationContext.xml
                2、Services 相关配置文件

            文件目录:WebRoot/WEB-INF/spring/services/Services_ApplicationContext.xml
                3
    、全局性配置文件
              文件目录: WebRoot/WEB-INF/spring/工程名+_ApplicationContext.xml
     5、JSP 文件
         采用完整的英文描述说明 JSP 所完成的功能,尽可能包括一个生动的动词,第一个字母小写, 如:viewMessage.jsp 、editUser.jsp 等。

     

     


    展开全文
  • JDK1.7-HashMap源代码注释

    千次阅读 多人点赞 2020-07-05 09:19:19
    JDK1.7-HashMap源代码注释

    我已加入CSDN合伙人计划

    亲爱的各位粉丝:可以添加我的CSDN官方企业微信号,和我近距离互动聊天,为您答疑解惑

    直接使用微信扫码即可,不用下载企业微信

    订阅之后,博主所有的专栏都可以学习查看,加入微信群有优惠哦,加入之后,找我返现哦
    在这里插入图片描述

    一、前言

    在学习java源码中,全是英文,

    展开全文
  • python将一段程序无效的方法发布时间:2020-09-03 14:27:12来源:亿速云阅读:89作者:小新小编给大家分享...1、python中可以用注释屏蔽一段语句,具体方法如下,首先打开一段python的示例程序:2、然后单行注释的...
  • 代码注释规范化

    2018-06-12 20:00:43
    代码使用过程中使用到注释是必要步骤,以下就几种注释以及其规范化进行讨论。程序语言注释笔记:一、注释的分类C语言中注释方法有多种例如://、/* */、#if 0等注释,下面就新手都使用过的//注释提出一些个人想法。1...
  • PHP代码注释规范

    2020-09-05 14:44:55
    PHP 代码中的注释不会被作为程序来读取和执行。它唯一的作用是供代码编辑者阅读。 二、PHP程序标准注释的规范准则 在项目代码内,文档在软件设计中起着至关重要的作用。在团队共同开发过程中, 注释对于帮助开发人员...
  • 代码注释作为编程语言的“说明文档”,它的作用不容小觑。然而,现实的开发中出现了不少不重视代码注释的行为。比如不写注释又命名的不规范,让人看了一头雾水。又比如有些人利用代码注释开车,搞笑。对此,我想说,...
  • 什么时候应该避免写代码注释?  英文原文:When Should You Avoid Commenting Your Code?  看到标题,我知道你可能会想:“我为什么要避免代码注释,这难道不是一件好事吗?”。是的,写注释在大多数...
  • 代码注释规范-google版本

    千次阅读 2016-06-29 13:05:06
    注释虽然写起来很痛苦,但对保证代码可读性至为重要,下面的规则描述了应该注释什么、注释在哪儿。当然也要记住,注释的确很重要,但最好的代码本身就是文档(self-documenting),类型和变量命名意义明确要比通过...
  • java代码注释规范

    千次阅读 2018-03-20 22:05:50
    一、规范存在的意义 ...2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码; 3、好的编码规范可以最大限度的提高团队开发的合作效率; 4、长期的规范性编码还可以让开发人...
  • 代码注释规范整理

    2013-09-23 21:18:31
    并且在流行的敏捷开发思想中已经提出了将注释转为代码的概念。好的注释规范可以尽可能的减少一个软件的维护成本,并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护。好的注释规范可以改善...
  • 一、代码注释 很简单,就是用英文的“’”分号开头,可以单独成行,也可以注释到每句代码结束处。如: Public Class ClsCustomEvent '自定义类 'Public Delegate Sub CustomEventHandler(ByVal...
  • 这样工作量可谓庞大,今天给大家带来关于注释的快捷键使用,一起来看看吧~关于python编程注释快捷键1、注释单行(1)方法1:直接在单行代码前边加 #(2)方法2:选中需要注释代码,Ctrl+/ 即可注释2、注释多行代码...
  • java代码注释规范(二)

    千次阅读 2016-07-01 10:20:36
    1、当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息?  2、怎么样避免我们的注释冗长而且凌乱不堪呢?  3、在多人协同开发、维护的今天,我们需要怎么样的...
  • 注释虽然写起来很痛苦,但对保证代码可读性至为重要,下面的规则描述了应该注释什么、注释在哪儿。当然也要记住,注释的确很重要,但最好的代码本身就是文档(self-documenting),类型和变量命名意义明确要比通过...
  • java代码注释规范(一)

    千次阅读 2016-07-01 10:15:43
    一、规范存在的意义  应用编码规范对于软件本身和软件开发人员而言尤为... 2、好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码;  3、好的编码规范可以最大限度的提高团队开发的
  • 04 隔空喊话,“友好”切磋 在代码注释里,程序员们还能隔着时空通过comment喊话,进行友好地交流与切磋。 比如下面这两行注释,就是跨越两年的一段喊话。 不过,一不小心,画风可能就变了,忍不住就Diss了一下。 ...
  • 一、背景及意义 略 二、用途 1、用于文档生成器工具自动生成最终生成代码...(3)在代码修改处加上修改标识的注释,以保证代码注释的同步。 (4)在循环和逻辑分支组成的代码中添加注释。 (5)为了防止问...
  • 就是这么加注释的,解析器在处理xml的时候已经不对注释部分处理了还...想在 android:layout_gravity="right"后面注释 可以双斜杠吗? 就像 .xml文件的注释是:,android:layout_gravity="right"。xml文件:...
  • 注释注释虽然写起来很痛苦,但对保证代码可读性至为重要,下面的规则描述了应该注释什么、注释在哪儿。当然也要记住,注释的确很重要,但最好的代码本身就是文档(self-documenting),类型和变量命名意义明确要比...
  • 我是多行注释1 我是多行注释2 我是多行注释3print(我上面的是多行注释)内容补充:以下实例我们可以输出函数的注释:def a():这是文档字符串passprint(a.__doc__)到此这篇关于python代码如何注释的文章就介绍到这了,...
  • 注释 注释虽然写起来很痛苦,但对保证代码可读性至为重要,下面的规则描述了应该注释什么、注释在哪儿。当然也要记住,注释的确很重要,但最好的代码本身就是文档(self-documenting),类型和变量命名意义明确...
  • 当你准备好的时候,你可以注释掉代码,并继续它的工作。 2)你编写了一个编译,但不正确的代码,你没有时间来解决它,直到以后。评论被破坏的代码将确保破碎的代码不会执行,并导致问题,直到你可以解决它。 3)...
  • 也谈代码注释的问题

    千次阅读 2014-04-03 11:02:31
    对于代码注释,大家较为一致的看法是代码中一定要有注释,这是毫无疑问的,但是如何去写注释,却是各有各的说法,今天看到一篇博客,其观点是:注释只写why,不写what和how。当然,前提是代码已能够很容易看出 what...
  • 整洁代码--写好注释

    2016-08-16 14:59:22
    但这种情况目前我只感觉是存在于理想中,现实中,尤其是国内,注释还是很重要的,注释写的清楚,能为阅读你代码的人提供很大的帮助,尤其是无法保证代码作者和阅读者英文水平不对等的情况下,中文注释显得尤为重要。...

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 48,559
精华内容 19,423
关键字:

把代码注释掉用英文