私は、開発者のほとんどが新しいメソッドを編集して追加できるSDKを持っています。 新しい機能を追加した各開発者に、文書化されたコメントを追加するよう強制したい。 文書化されたコメントには、このメソッドのサポートされているバージョンが含まれている必要があります。私は、XMLドキュメントファイルを追加し、それが私の作品概要について （なし文書コメント場合は、ビルドが失敗した） が、私はまだサポートされているバージョンのためのソリューションを持っていないコメントドキュメントのコメントを強制するには
/// <summary>
/// Function1 description
/// </summary>
/// <**supportedSince**>Version 5.6</**supportedSince**>
public List<string> Function1{ get; set; }
Warning CS1591をするときXML comments are missing
生成されますその個々の警告をエラーとして扱うことができます。これは問題のソースコードを使用するプロジェクトごとに行う必要があります。
/warnaserrorだからあなたは、各プロジェクトの設定にこのコンパイラオプションを追加することができます参照してください：
/warnaserror:1591
これにより、コメントが追加されるだけです。それは、実際に有用で意味のあるコメントを追加することを強制しません。 –
永遠の問題。コメントを読み、その意味や有用性を判断し、協力を拒否するプログラマーを解雇しなければならないと思います。だからこそ彼らはチームリーダーと開発マネージャに大金を払うのです。 – buffjape
他の手法には、コードレビュー（すべての変更または偶発的なもののいずれか）と、良い文書の重要性に関する新しいチームメンバーの指導が含まれます。または、SDKを作成した開発者は、SDKのコンシューマー向けのファーストライン・サポートとして機能します。ドキュメンテーションが不十分な場合は、より多くのサポート・クエリが得られ、よく書かれ、使用可能なドキュメントの重要性が強調されます。 –
私の知る限りでは、stylecopはこれを行うことができます。使用しているSCMでpre-commit/pre-pushフックを設定できます。 – rpeshkov