null+****@clear*****
null+****@clear*****
2012年 3月 19日 (月) 16:13:20 JST
Kouhei Sutou 2012-03-19 16:13:20 +0900 (Mon, 19 Mar 2012)
New Revision: 191f4d8c213ca2094f406fb55e5e4c384ee8b7d8
Log:
doc coding style: add about include guard
Modified files:
doc/source/developer/coding_style.rst
Modified: doc/source/developer/coding_style.rst (+30 -0)
===================================================================
--- doc/source/developer/coding_style.rst 2012-03-19 09:51:20 +0900 (5cae01d)
+++ doc/source/developer/coding_style.rst 2012-03-19 16:13:20 +0900 (ac2d049)
@@ -90,6 +90,36 @@ TODO: 読みやすさの他にデバッグのしやすさ（gdbでの追いや
ha_mroonga.cpp:
using namespace zmq;
+``include`` ガード
+------------------
+
+2重 ``include`` を防ぐためのマクロは、ヘッダーファイルの名前をすべて大文字にし、単語の区切りをアンダースコアにしたものにし、最後にアンダースコアをつけて ``HEADER_FILE_NAME_HPP_`` という名前にする。
+
+よい例:
+
+ mrn_db_path.hpp:
+ #ifndef MRN_DB_PATH_HPP_
+ #define MRN_DB_PATH_HPP_
+ ...
+ #endif // MRN_DB_PATH_HPP_
+
+悪い例（小文字になっている）:
+
+ mrn_db_path.hpp:
+ #ifndef mrn_db_path_hpp_
+ #define mrn_db_path_hpp_
+ ...
+ #endif // mrn_db_path_hpp_
+
+悪い例（アンダースコアが最後ではなく先頭についている）:
+
+ mrn_db_path.hpp:
+ #ifndef _MRN_DB_PATH_HPP
+ #define _MRN_DB_PATH_HPP
+ ...
+ #endif // _MRN_DB_PATH_HPP
+
+
文字列
------