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

Timestamp:

2007/07/30 11:02:17 (17 years ago)

Author:

nanasess

Comment:

--

EC-CUBE標準規約

@@ -1 +1 @@
 [[TOC]]
-※ まだ書きかけです...
 = EC-CUBE標準規約 =
 基本的に [http://framework.zend.com/manual/ja/coding-standard.html Zend Framework PHP 標準コーディング規約] に順ずる.[[BR]]
@@ -55 +54 @@
 
 === DBカラム名 ===
- * ''特に定義なし''
+ * 特に指定の無い限り, すべて小文字を使用する.
+ * 区切り文字としてアンダースコア(_)を使用する.
 
 === CSS クラス名 ===
@@ -68 +68 @@
  * PHPコードの開始タグと, 終了タグは以下のように記述する.
  * 終了タグの後に必ず '''LF''' (UNIX の改行コード)を1つ入れる.
- * 余分な行末の空白は極力無くす.
-{{{
-#!php
-<?php
-
+ * 余分な空行, 行末の空白は極力削除する.
+   * Eclipse でコーディングする場合, [http://andrei.gmxhome.de/anyedit/ AnyEdit プラグイン] を使用すると自動的にやってくれる
+ * クラス定義, 関数定義の後, 括弧の後で改行する.
+ * 80 文字を目安に改行する.
+{{{
+#!php
+<?php
+class LC_Page_Abouts {
+
+    function process() {
+        // some logic.
+    }
+}
 ?>
 
@@ -159 +167 @@
 
 === 文字列 ===
+ * 長くなる文字列は分割し, "." で結合する.
+{{{
+#!php
+<?php
+$sql = "SELECT name, age, birthday, zipcode, address, comment "
+     . "  FROM user_information "
+     . " WHERE user_id = ? "
+     . "   AND is_delete = 0 ";
+?>
+
+}}}
+
 === SQL文 ===
-=== コメント ===
+ * フォームから入力された値を利用して SQL文を生成する場合, SQLインジェクションを防ぐため, 必ず PearDB のブレースホルダを利用する.
+
+== コメント ==
+ * コメントのコーディングは基本的に [http://www.phpdoc.org/ phpDocumentor] に準ずる.
+
+=== ヘッダ ===
+ * 各ファイルのヘッダに著作権表記を記述する.
+{{{
+#!php
+<?php
+/*
+ * Copyright(c) 2000-2007 LOCKON CO.,LTD. All Rights Reserved.
+ *
+ * http://www.lockon.co.jp/
+ */
+?>
+
+}}}
+
+=== クラス定義 ===
+ * phpDoc コメントは必要に応じて記述する.
+ * '''@version''' は '''$Id$''' を使用する.
+   * [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''' とすることで自動展開される.
+ * メンバ変数は '''/** */''' を使用することによって phpDoc コメントとして認識される.
+{{{
+#!php
+<?php
+/**
+ * クラスの簡単な説明
+ *
+ * クラスの詳細な説明....
+ * ...
+ *
+ * @package Page
+ * @author LOCKON CO.,LTD.
+ * @version $Id$
+ */
+class LC_Page {
+
+    /** メンバ変数 */
+    var foo;
+
+}
+?>
+
+}}}
+
+=== 関数定義 ===
+ * phpDoc コメントは必要に応じて記述する.
+   * '''@param と @return は必須'''
+ * コード文中にも必要に応じて的確なコメントを記述する.
+{{{
+#!php
+<?php
+
+// }}}
+// {{{ functions
+
+/**
+ * 関数の簡単な説明.
+ *
+ * 関数の詳細な説明....
+ * ....
+ *
+ * @access private
+ * @param string $foo 引数の説明
+ * @param string|integer $bar 引数の説明
+ * @return string 返り値の説明
+ */
+function process($foo, $bar = "") {
+    // some process...
+    return "string value";    
+}
+?>
+
+}}}
+
+=== その他 ===
+ * 必要に応じて, 下記のタスクタグを使用しても良い
+   * '''TODO''' - TODO として残したいコメント
+   * '''FIXME''' - 必ず修正することを促すコメント
+   * '''XXX''' - 動くけど怪しい...
+{{{
+#!php
+<?php
+
+// FIXME 要修正. バグの説明(#135)
+
+/*
+ * :XXX: 以下, 怪しいロジック(#999)
+ * 複数行のコメントはこのように.
+ *
+ * 必要に応じて チケットの ID も記述する.
+ */
+
+?>
+
+}}}
+ * コメントによってソースコードが見難くならないように注意する.