Changes between Version 9 and Version 10 of EC-CUBE標準規約


Ignore:
Timestamp:
2007/07/30 11:02:17 (14 years ago)
Author:
nanasess
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • EC-CUBE標準規約

    v9 v10  
    11[[TOC]] 
    2 ※ まだ書きかけです... 
    32= EC-CUBE標準規約 = 
    43基本的に [http://framework.zend.com/manual/ja/coding-standard.html Zend Framework PHP 標準コーディング規約] に順ずる.[[BR]] 
     
    5554 
    5655=== DBカラム名 === 
    57  * ''特に定義なし'' 
     56 * 特に指定の無い限り, すべて小文字を使用する. 
     57 * 区切り文字としてアンダースコア(_)を使用する. 
    5858 
    5959=== CSS クラス名 === 
     
    6868 * PHPコードの開始タグと, 終了タグは以下のように記述する. 
    6969 * 終了タグの後に必ず '''LF''' (UNIX の改行コード)を1つ入れる. 
    70  * 余分な行末の空白は極力無くす. 
    71 {{{ 
    72 #!php 
    73 <?php 
    74  
     70 * 余分な空行, 行末の空白は極力削除する. 
     71   * Eclipse でコーディングする場合, [http://andrei.gmxhome.de/anyedit/ AnyEdit プラグイン] を使用すると自動的にやってくれる 
     72 * クラス定義, 関数定義の後, 括弧の後で改行する. 
     73 * 80 文字を目安に改行する. 
     74{{{ 
     75#!php 
     76<?php 
     77class LC_Page_Abouts { 
     78 
     79    function process() { 
     80        // some logic. 
     81    } 
     82} 
    7583?> 
    7684 
     
    159167 
    160168=== 文字列 === 
     169 * 長くなる文字列は分割し, "." で結合する. 
     170{{{ 
     171#!php 
     172<?php 
     173$sql = "SELECT name, age, birthday, zipcode, address, comment " 
     174     . "  FROM user_information " 
     175     . " WHERE user_id = ? " 
     176     . "   AND is_delete = 0 "; 
     177?> 
     178 
     179}}} 
     180 
    161181=== SQL文 === 
    162 === コメント === 
     182 * フォームから入力された値を利用して SQL文を生成する場合, SQLインジェクションを防ぐため, 必ず PearDB のブレースホルダを利用する. 
     183 
     184== コメント == 
     185 * コメントのコーディングは基本的に [http://www.phpdoc.org/ phpDocumentor] に準ずる. 
     186 
     187=== ヘッダ === 
     188 * 各ファイルのヘッダに著作権表記を記述する. 
     189{{{ 
     190#!php 
     191<?php 
     192/* 
     193 * Copyright(c) 2000-2007 LOCKON CO.,LTD. All Rights Reserved. 
     194 * 
     195 * http://www.lockon.co.jp/ 
     196 */ 
     197?> 
     198 
     199}}} 
     200 
     201=== クラス定義 === 
     202 * phpDoc コメントは必要に応じて記述する. 
     203 * '''@version''' は '''$Id$''' を使用する. 
     204   * [http://subversion.bluegate.org/doc/ch07.html#svn.advanced.confarea.opts.config enable-auto-props を有効] にし, [http://subversion.bluegate.org/doc/ch07s02.html#svn.advanced.props.special.keywords svn:keywords] で '''*.php = svn:keywords=Id''' とすることで自動展開される. 
     205 * メンバ変数は '''/** */''' を使用することによって phpDoc コメントとして認識される. 
     206{{{ 
     207#!php 
     208<?php 
     209/** 
     210 * クラスの簡単な説明 
     211 * 
     212 * クラスの詳細な説明.... 
     213 * ... 
     214 * 
     215 * @package Page 
     216 * @author LOCKON CO.,LTD. 
     217 * @version $Id$ 
     218 */ 
     219class LC_Page { 
     220 
     221    /** メンバ変数 */ 
     222    var foo; 
     223 
     224} 
     225?> 
     226 
     227}}} 
     228 
     229=== 関数定義 === 
     230 * phpDoc コメントは必要に応じて記述する. 
     231   * '''@param と @return は必須''' 
     232 * コード文中にも必要に応じて的確なコメントを記述する. 
     233{{{ 
     234#!php 
     235<?php 
     236 
     237// }}} 
     238// {{{ functions 
     239 
     240/** 
     241 * 関数の簡単な説明. 
     242 * 
     243 * 関数の詳細な説明.... 
     244 * .... 
     245 * 
     246 * @access private 
     247 * @param string $foo 引数の説明 
     248 * @param string|integer $bar 引数の説明 
     249 * @return string 返り値の説明 
     250 */ 
     251function process($foo, $bar = "") { 
     252    // some process... 
     253    return "string value";     
     254} 
     255?> 
     256 
     257}}} 
     258 
     259=== その他 === 
     260 * 必要に応じて, 下記のタスクタグを使用しても良い 
     261   * '''TODO''' - TODO として残したいコメント 
     262   * '''FIXME''' - 必ず修正することを促すコメント 
     263   * '''XXX''' - 動くけど怪しい... 
     264{{{ 
     265#!php 
     266<?php 
     267 
     268// FIXME 要修正. バグの説明(#135) 
     269 
     270/* 
     271 * :XXX: 以下, 怪しいロジック(#999) 
     272 * 複数行のコメントはこのように. 
     273 * 
     274 * 必要に応じて チケットの ID も記述する. 
     275 */ 
     276 
     277?> 
     278 
     279}}} 
     280 * コメントによってソースコードが見難くならないように注意する.