doc coding-style: add about constant

mroonga · Mar 15, 2012 · 2548a74 · 2548a74
1 parent c8d570b
commit 2548a74
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/doc/source/developer/coding_style.rst b/doc/source/developer/coding_style.rst
@@ -383,3 +383,16 @@ voidを省略
 	 column.set_value(value);
       }
     }
+
+定数
+----
+
+フラグやサイズなどを示す定数には ``const`` オブジェクトを用いる。これはデバッガー上でプログラムを走らせているときに名前で値を参照できるようにするためである。
+
+よい例:
+
+    const char *MRN_LOG_FILE_PATH = "groonga.log";
+
+悪い例（ ``#define`` を用いている）:
+
+    #define MRN_LOG_FILE_PATH "groonga.log"