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