zoukankan      html  css  js  c++  java
  • Android/Java 代码注释标准规范

    1、 ⽂件头注释
       每⼀个⽂件的⽂件头都必须做⽂件头注释。⽂件头注释范例如下:
     
    2、 ⽅法头注释
      每⼀个成员⽅法(包括⾃定义成员⽅法、覆盖⽅法、属性⽅法)的⽅法头都必须做⽅法头注释。
       ⾃定义成员⽅法注释范例如下:
     
       覆盖(重写)成员⽅法注释范例如下:
     

     

    属性 getter 和 setter 成员⽅法注释范例如下:

     3、 块注释

    在实现⼀段阶段性功能的代码前做块注释。块注释的注释范例如下:
     

     4、 变量注释

    所有的成员变量和⼤多数局部变量在声明时都需要为其做功能注释。
    成员变量注释的注释范例如下:
     
     
    局部变量注释的注释范例如下:
     
    5、 语句注释
    在关键语句的右侧要做单条语句注释。
    语句注释的注释范例如下:
     

     6、 有关注释的其它说明

    (1) ⽂件头和⽅法头注释应该使⽤/**/形式,变量注释和语句注释应该使
    ⽤//形式,块注释应尽量使⽤//形式,当⽂字较长(单屏横向不能显
    ⽰完全)时块注释也可以使⽤/**/形式;
    (2) 注释量必须不少于代码总量的三分一
  • 相关阅读:
    JavaScript数据类型(第一天)
    数据库的事务隔离级别
    SSH(远程登录)原理
    Hadoop安装
    activiti学习第二天
    activiti学习第一天
    .net调用系统软键盘(兼容win7及win10)
    使用Blend设计出符合效果的WPF界面
    Mysql的收获
    PHP文件上传安全处理的步骤
  • 原文地址:https://www.cnblogs.com/ComputerVip/p/11661330.html
Copyright © 2011-2022 走看看