javascriptコメント規範

1909 ワード

jsの組織はモジュール化で、一つのモジュールは一つのjsファイルに対応します.
モジュール機能説明:
/**
 * ------------------------------------------------------------------
 *       
 * ------------------------------------------------------------------
 */
モジュール内の小関数メソッドの分類:
/**
 *          ,                          
 * ------------------------------------------------------------------
 */
一つの業務方法から抽出した小さな関数を一緒に置くと、探しやすいです.
単一関数の方法:
/**
 *       
 *
 *         
 *
 * @param    {string}  address       
 * @param    {array}   com             
 * @param    {string}  pay_status      
 * @returns  void
 *
 * @date     2014-04-12
 * @author   QETHAN
 */
単一の行のコメント:
//        
このような人が好きです. //これは単一行の注釈です. 二重のスラッシュの後ろにスペースがあります.認めません.洗練された簡潔が好きで、適時には必ずそうします.
単一の関数方法における変数のコメント:
//      (      )
    //    (      )
var name = $(item).find('.js-name').val(),
    //    
    count = $(item).find('.js-count').text(),
    //    
    price = $(item).find('.js-price').val();
いくつかのコメントは単一変数の後ろに置くのが好きです.変数のコメントが少し長いと、あまり良くないです.上に置くと、比較的に気が楽で、はっきりしています.
単一の関数方法におけるコードセグメントのコメント:
/*
 |          
 */