[Groonga-mysql-commit] mroonga/mroonga [master] doc coding-style: add about naming rule for reader

Back to archive index

null+****@clear***** null+****@clear*****
2012年 3月 15日 (木) 15:49:04 JST


Kouhei Sutou	2012-03-15 15:49:04 +0900 (Thu, 15 Mar 2012)

  New Revision: 11106f7438443c570aa4b43a1a4d483f6028ac1c

  Log:
    doc coding-style: add about naming rule for reader

  Modified files:
    doc/source/developer/coding_style.rst

  Modified: doc/source/developer/coding_style.rst (+29 -0)
===================================================================
--- doc/source/developer/coding_style.rst    2012-03-15 15:08:49 +0900 (56a560a)
+++ doc/source/developer/coding_style.rst    2012-03-15 15:49:04 +0900 (e2eb159)
@@ -197,3 +197,32 @@ TODO: ちゃんと考える。
        char *my_name;
      }
 
+読み込み用アクセサ名
+^^^^^^^^^^^^^^^^^^^^
+
+メンバー変数の値を読み込むメソッドの名前はメンバー変数名の末尾のアンダースコアを除いたものにする。
+
+よい例:
+
+    class MyClass
+    {
+      char *my_name_;
+      const char *my_name() {return my_name_;};
+    }
+
+悪い例(末尾にアンダースコアが残っている):
+
+    class MyClass
+    {
+      char *my_name_;
+      const char *my_name_() {return my_name_;};
+    }
+
+悪い例(先頭に ``get_`` を付けている):
+
+    class MyClass
+    {
+      char *my_name_;
+      const char *_my_name() {return my_name_;};
+    }
+




Groonga-mysql-commit メーリングリストの案内
Back to archive index