★APIリファレンス
APIリファレンスで記述可能なタグ。XMLドキュメントコメントとは違う部分もある。
クラス, フィールド, プロパティ, インデクサ : summaryタグ, remarksタグ, newparaタグ
メソッド : summaryタグ, remarksタグ, newparaタグ, に加え, paramタグ, returnsタグ
XMLドキュメントコメントでは、以下の注意点がある。
・paraタグは、summaryタグ内で使用すると第1段落しか表示されないことがある。
・enum(列挙体)の各値は、summaryタグのみ有効。
APIリファレンスでも準拠したほうがいいかもしれない。
<参考>
・@IT:Visual Studio .NETによるチーム開発事始め Visual C# .NETでAPIリファレンスを作る(後編)
・C#のドキュメントコメントを書く際の注意点 - 熱燗ロックのブログ
★C/C++ enum スコープ
<参考>
・enumのスコープを指定する方法 - CREST’S WEBLOG (跡地)
★C/C++ 循環
なお, enum の前方宣言ができるようになったのは最近の C/C++ から.
<参考>
・ぽこつん研究所 » 名前空間を含む、複雑な型の前方宣言
APIリファレンスで記述可能なタグ。XMLドキュメントコメントとは違う部分もある。
クラス, フィールド, プロパティ, インデクサ : summaryタグ, remarksタグ, newparaタグ
メソッド : summaryタグ, remarksタグ, newparaタグ, に加え, paramタグ, returnsタグ
XMLドキュメントコメントでは、以下の注意点がある。
・paraタグは、summaryタグ内で使用すると第1段落しか表示されないことがある。
・enum(列挙体)の各値は、summaryタグのみ有効。
APIリファレンスでも準拠したほうがいいかもしれない。
<参考>
・@IT:Visual Studio .NETによるチーム開発事始め Visual C# .NETでAPIリファレンスを作る(後編)
・C#のドキュメントコメントを書く際の注意点 - 熱燗ロックのブログ
★C/C++ enum スコープ
<参考>
・enumのスコープを指定する方法 - CREST’S WEBLOG (跡地)
★C/C++ 循環
なお, enum の前方宣言ができるようになったのは最近の C/C++ から.
<参考>
・ぽこつん研究所 » 名前空間を含む、複雑な型の前方宣言