js/javascriptコード注釈仕様と例

3184 ワード
JavaScript java 基礎 コメント 集合する
注釈コードの作成過程における重要性は,コードを書くことが半年を超えると深く体得できる.コメントのないコードは良いコードではありません.他の人のために勉強すると同時に、自分のために後でコードを「アップグレード」するために、js/javascriptコード注釈規範と例を見てみましょう.
ファイルアノテーションファイルアノテーションはファイルの一番前にあり、ファイルの以下の情報を含むべきである:概要説明及びバージョン(必須)プロジェクトアドレス(オープンソースコンポーネント必須)著作権声明(必須)オープンソースプロトコル(オープンソースコンポーネント必須)バージョン番号(必須)修正時間(必須)、ISO形式で表す(Sublime TextのInsertDateプラグインで挿入可能)ファイルコメントはすべて英字で表示され、ファイルの開発バージョンと本番バージョンに存在する必要があります.たとえば、次のようになります.
/*!
 * jRaiser 2 Javascript Library
 * waterfall - v1.0.0 (2013-03-15T14:55:51+0800)
 * http://jraiser.org/ | Released under MIT license
 */
  
/*!
 * kan.56.com - v1.1 (2013-03-08T15:30:32+0800)
 * Copyright 2005-2013 56.com
 */
ファイルにいくつかのオープンソースコンポーネントが含まれている場合は、ファイルコメントで説明する必要があります.例:
/*!
 * jRaiser 2 Javascript Library
 * sizzle - v1.9.1 (2013-03-15T10:07:24+0800)
 * http://jraiser.org/ | Released under MIT license
 *
 * Include sizzle (http://sizzlejs.com/)
 */
 
一般的な注釈一般的な注釈は、開発者と読者がプログラムをよりよく理解し、APIドキュメントに表示されないようにするためです.ここで、単行注釈は「//」で始まる.複数行のコメントは「/*」で始まり、「*/」で終わります.一般コメントの使用は以下の規定に従う必要があります.
  • は、常に1行のコメントの後にスペースを残します.例:
    // this is comment
  • は、常に複数行のコメントの末尾にスペースを残します(アスタリスクを揃えます).たとえば、
    /*
                             
 */
    、
    • などです.
  • 複数行の注釈の先頭、終点の行に注釈を書かないでください.例:
  • /* start
                             
end */
      
    /*
here is line 1
here is line 2
 */
     
  • 無意味な注釈は書かないでください.例:
  • //    value   0
var value = 0;
     
  • あるセグメントのコードに機能が実装されていない場合、または改善が必要な場合は、「TODO」タグを追加する必要があります.「TODO」の前後にスペースを残します.例:
    // TODO    IE6-8    
function setOpacity(node, val) {
    node.style.opacity = val;
}
  • 文書注記
    • ドキュメントコメントは、APIドキュメントに所定の形式で表示されます.「/**」で始まり、「*/」で終わり、各行は「*」で始まり、コメントの内容と「*」の間にスペースが残ります.たとえば、次のようになります.
    /**
 * comment
 */
    ドキュメントコメントには、1つ以上のコメントラベルが含まれている必要があります.
  •  @module.宣言モジュール、使用法:
    /**
 *     
 * @module    
 */
    例:
    /**
 * Core       、      
 * @module Core
 */
    @class.宣言クラス、使用法:
    /**
 *    
 * @class   
 * @constructor
 */
    @classは@constructorまたは@staticと組み合わせて使用する必要があります.非静的クラスと静的クラスをそれぞれマークします.
    /**
 *      
 * @class NodeList
 * @constructor
 * @param {ArrayLike<Element>} nodes      
 */
     
  • @method.関数またはクラスメソッドを宣言します.使用方法:
    /**
 *     
 * @method    
 * @for     
 * @param {    }         
 * @return {     }      
 */
    @forが指定されていない場合は、この関数がグローバルまたはモジュールの最上位関数であることを示します.関数が静的関数の場合、@staticを追加する必要があります.関数にパラメータがある場合は@paramを使用する必要があります.関数に戻り値がある場合は、@returnを使用する必要があります.
    /**
 *               
 * @method
 * @for NodeList
 * @param {Number} [i=0]     。     ，               
 * @return {Element}     
 */
      @param.関数パラメータを宣言し、@methodと組み合わせて使用する必要があります.
  • パラメータが次の場合、対応するフォーマットを使用します.
    [   ]
    パラメータにはデフォルト値があります.
    [   =   ]
    @propertyです.宣言クラス属性、用法:
    /**
 *     
 * @property {    }    
 */
    発見と:www.lifefrom.com/qianduan/336.html
    • Luaにおけるメモリ管理と解放の理解
    POH6+ C# 解答