项目注释心得

个人想法，仅供参考

 

一个js>>一个jsp>>一个servlet>>>一个class

         js方法注释：

    //js文件的主要作用

    /*
        功能：           创建新的图章对象
        参数 obj:      图章对象
        返回值 ：     无
*/
function view_big(c) {
 var a = document.createElement("div");
 a.id = "phdiv";
 var b = document.createElement("img");
 if (c.src.indexOf(".") != -1) {
  b.src = c.src;
  a.appendChild(b);
  a.style.position = "absolute";
  a.style.left = site(c)[0];
  a.style.top = site(c)[1];
  b.width = "160";
  b.height = "240";
  document.getElementsByTagName("body")[0].appendChild(a)
 }
}

             servlet注释：

//servlet文件的主要作用：

  /** 
  * FunName：     doPost
  * Description ：   实现人员信息的保存
  * param String muban_lx: 模板类型 
  * param File tempFile:  文件流
  */

          jsp注释：

//jsp文件的主要作用

<title>文件上传</title>
     <!--
     FunName      upFile.jsp
      Description ：    该页面主要实现文件上传  
     @param String xm_id：  项目编号
      @param String rurl：  转向的页面
      @param String fbh：   归档编号
      @param String ssmk_id：  所属模块编号
      @param String gclb：  工程编号
     -->

 

class类方法的注释：

       /** 
  *作用:        将数据库表内容导出 
  * @param String address:                     存放路径
  * @param String tbname :                     数据库表表名
  * @param String str_zdname_en:        数据所在列的列编号
  * @param String arr_zdname_ch:        数据所在列的列名
  * @return 无
  */