ドキュメント規則
ドキュメント規則では、外部から参照可能な API に XML ドキュメント コメントを正しく使用することによって、適切にドキュメント化されたライブラリの作成をサポートします。
このセクションの内容
ルール | 説明 |
---|---|
CA1200:プレフィックスで cref タグを使用しません | XML ドキュメント タグの cref 属性は "コード参照" を意味します。 タグの内部テキストが、型、メソッド、プロパティなど、コード要素であることを指定します。 cref タグとプレフィックスを一緒に使用すると、コンパイラで参照を検証できなくなるため、一緒に使用しないでください。 また、Visual Studio 統合開発環境 (IDE) でリファクタリング中にこれらのシンボル参照を見つけたり、更新したりすることもできなくなります。 |
GitHub で Microsoft と共同作業する
このコンテンツのソースは GitHub にあります。そこで、issue や pull request を作成および確認することもできます。 詳細については、共同作成者ガイドを参照してください。
.NET