☰

ドキュメントコメントはどこに記述すればよいですか? [重複] 質問する

tag-icon • tag-icon c++ header documentation
ドキュメントコメントはどこに記述すればよいですか? [重複] 質問する

前方宣言を含むヘッダー ファイル内ですか、それとも実装を含む .cpp ファイル内ですか?

//header.h
/* About foo() */
void foo();
/* About bar() */
int bar();
/* About A */
class A
{
public:
    /* About A's constructor */
    A();
    ....
}

または

//implementation.cpp
/* About foo() */
void foo()
{
    ...
    ...
}
/* About bar */
int bar()
{
    ...
}
/* About A's constructor */
A::A()
{
    ...
}

ベストアンサー1

使用方法に関する情報は、ヘッダーに入れるのがよいでしょう。人々が最初に見るのはそこです。

コンポーネントの使用方法を理解するために .cpp ファイルを調べる必要がなければ、ドキュメントは本当に成功していると言えます。

おすすめ記事