私はCで小さなプログラムを書いています。他の人が詳細を変更できるように文書化したいです。#define
一部の操作を有効にするかどうかを指定して config.h ファイルを作成しました。相互に排他的なものもあれば、そうでないものもあります。
相互に排他的でない例:
#define USE_A
#define USE_B
#define USE_C
相互に排他的な例:
#define BUILD_FULL
#define BUILD_COMPACT
これまで、使用したくない機能を文書化することで、コンパイルするプログラムの構成を選択していました。たとえば、次のようになります。
//#define BUILD_FULL
#define BUILD_COMPACT
COMPACT 実行可能ファイルをビルドします。
コメントアウトされた機能のドキュメントを作成するにはどうすればよいですか?
私は試した:
#define USE_A //!< Special Feature
#define USE_B //!< Special Feature
//#define USE_C //!< Special Feature
なしでコンパイルしましたUSE_C
が、doxygen が解析しなかったため、明らかにドキュメントを失いました。#define
defineの正しい使用方法を誤解した場合、どのようにフローを書き直しますか?