Changes between Version 6 and Version 7 of EC-CUBE標準規約

Timestamp:

2007/07/27 21:24:25 (17 years ago)

Author:

nanasess

Comment:

--

EC-CUBE標準規約

@@ -32 +32 @@
 ||sf          ||一つのサイト内で共有する関数||sfGetProductName()||
 ||lf          ||一つのソースファイル内で使用する関数||lfGetProductName()||
-||fn          ||JavaScript で宣言された関数||fnGetProductName()||
+||fn          ||!JavaScript で宣言された関数||fnGetProductName()||
 
 === 変数名(Smarty 変数も含む) ===
@@ -38 +38 @@
    * ループ等で一時的に使用する, 数値型の変数には慣習的な $i, $j, $k を使用しても良い.
  * 区切り文字としてアンダースコア(_)を使用する.
-||'''Prefix'''||
+||'''Prefix'''||'''種類'''||'''例'''||
+||obj         ||クラス変数(オブジェクト)||$objDb_Conn||
+||arr         ||配列||$arrCustName||
 
 === 定数名 ===
+ * すべて大文字で宣言する.
+ * 区切り文字としてアンダースコア(_)を使用する.
+
 === DBテーブル名 ===
+ * テーブル名の先頭には, 小文字でその種類を表す Prefix を付加する.
+ * 区切り文字としてアンダースコア(_)を使用する.
+||'''Prefix'''||'''種類'''||'''例'''||
+||mtb         ||マスタデータ||mtb_pref||
+||dtb         ||データテーブル||dtb_shop||
+||vw          ||ビュー    ||lvw_order||
+
 === DBカラム名 ===
+ * ''特に定義なし''
+
 === CSS クラス名 ===
+ * ''特に定義なし''
 
 == コーディング規約 ==
+
 === HTML ===
+ * ラジオボタン, チェックボックスは '''<label></label>''' で囲み, 文字をクリックしてもチェックされるようにする.
+
 === PHPコード ===
+ * PHPコードの開始タグと, 終了タグは以下のように記述する.
+   * 終了タグの後に必ず '''LF''' (UNIX の改行コード)を1つ入れる.
+{{{
+#!php
+<?php
+
+?>
+
+}}}
+
 === 制御文 ===
+ * if, for, while, switch 等の制御構造は, 次のルールで開き括弧で記述する.
+ * インデントは, 半角スペース4文字を使用し, タブは使用しない.
+
+=== if 文 ===
+ * 判定文の対象となる処理結果は先に記述する.
+
+{{{
+#!php
+<?php
+if ($flag == '1') { // '1' == $flag と書くのは NG
+    $ret = 1;
+} elseif ($flag == '2') {
+    $ret = 2;
+} else {
+    $ret = 3;
+}
+?>
+
+}}}
+=== for 文 ===
+{{{
+#!php
+<?php
+for ($i = 0; $i < $max; $i++) {
+    echo $i . "\n";
+}
+?>
+
+}}}
+=== foreach 文 ===
+{{{
+#!php
+<?php
+foreach ($var as $key => $val) {
+    echo $key . ":" . $val . "\n";
+}
+?>
+
+}}}
+=== while 文 ===
+{{{
+#!php
+<?php
+while ($flag) {
+    var_dump($flag);
+}
+?>
+
+}}}
+=== do while 文 ===
+{{{
+#!php
+<?php
+do {
+    var_dump($flag);
+} while ($flag);
+?>
+
+}}}
+=== switch 文 ===
+{{{
+#!php
+<?php
+switch ($var) {
+case VAR_ONE:
+    echo "one";
+    break;
+
+case VAR_TWO:
+    echo "two";
+    break;
+
+default:
+    echo "default":
+
+}
+?>
+
+}}}
+   * case の記述は, 定数を用いるのが望ましい.
+
 === 文字列 ===
 === SQL文 ===