C# で Web Client Software Factory (WCSF) を使用して ASP.net Web アプリケーションで作業しているときに、このジレンマに遭遇しました。同じことが他のプラットフォームや言語にも当てはまる可能性があります。私の状況は次のとおりです。
WCSF パラダイムに基づいて各 Web ページ/ユーザー コントロールの I View インターフェイスを定義してから、ページ クラスに I View インターフェイスを実装させ、基本的にインターフェイスで定義された各メソッドを実装します。メソッド レベルで xml-documentation を追加しようとしたとき、基本的に、インターフェイス メソッドと実装クラスの対応する部分の両方に対して同じコメント コンテンツを繰り返していることに気付きました。
私の質問は次のとおりです。インターフェイス メソッドと対応するクラス メソッドのドキュメント コンテンツの間に実質的な違いがあるはずですか? 彼らは別の側面か何かを強調すべきですか？
インターフェイス メソッドのコメントにはメソッドが「何をするか」を記述し、クラス メソッドのコメントには「どのように」メソッドを実行するかを記述する必要があると誰かが私に言いました。しかし、メソッド レベルのコメントは、メソッドが実行することになっている "何" だけを記述すべきであり、メソッドの実装の詳細を記述すべきではないことを以前どこかで読んだことを覚えています。