2

インターフェイスとそれを実装するクラスがあり、それに対するxmlコメントをVSインテリセンスまたはドキュメントで使用する場合は、xmlコメントをどこに配置しますか?インターフェイスのメソッドまたは具体的なクラスメソッドに?正しい方法は何ですか?

インターフェイスを使用して変数を宣言しているので、インターフェイスに配置することを考えています。また、具象クラスにもコメントを付けて、同じメソッドで異なるドキュメントが作成される可能性があることを確認すると、冗長になると思います。

何かアイデア、アドバイスはありますか?

4

1 に答える 1

3

公開メンバーについて文書化する必要があります。ISomeInterface.SomeMemberを実装している場合public void SomeMemberは、文書化する必要があります。一つには、読者はこれをあなたのクラスの一部として見るでしょう、そして(それがそこにないかどうか見ることができない)ドキュメントを読むことによってのみ、彼らはそれがそのインターフェースで定義されていることを知るでしょう。そのように実装されている場合void ISomeInterface.SomeMemberは、クラスのパブリックインターフェイスの一部として表示されないため、それほど重要ではありません。

また、特定のクラスが特定のインターフェイスメンバーをどのように実装したかについての詳細を知ることも重要な場合があります。

一方、非常に短い説明を提供し、詳細についてはインターフェイスのドキュメントを参照するのが妥当な場合があります。

于 2010-08-17T01:54:40.690 に答える