7

クラスがインターフェースで定義されたメソッドを実装する場合、ドキュメントを複製するか、で参照するかを選択できます<see cref="..." />。

public interface IPerformer
{
    /// <summary>
    /// Do something useful.
    /// </summary>
    /// <param name="something">Object to do something with</param>
    void Do(Something something);
}

public class Implementation : IPerformer
{
    /// <copy from="IPerformer" /> # that is what I want!
    public void Do(Something something)
    {
        // implementation ...
    }
}

APIドキュメントツール（Sandcastle）にドキュメントを自動的にコピーさせることは可能ですか（APIドキュメントをより快適に読むために何が必要ですか）？@inheritDocJava Docのようなものですか？

4

4 に答える 4

4

あなたが探している答えは完全ではありませんが、GhostDocはあなたのためにこれを行うことができます。インターフェースから実装にコメントをプルします。

于 2011-06-01T15:29:07.377 に答える
3

Sandcastleヘルプファイルビルダー（SHFB）は、inheritdocタグを介してこの機能を提供します。

于 2011-06-11T18:45:42.830 に答える
3

JetbrainのResharperを使用すると、インターフェイスからコメントをコピーできます（または、インターフェイスからインスタンスを作成すると、自動的にコピーされます）が、インターフェイスのコメントを更新する場合は、コメントを削除して、ベースからコメントを再度コピーする必要があります。

于 2011-06-01T16:03:24.620 に答える
1

AtomineerUtils Proのドキュメントは、基本クラス、インターフェイス、およびオーバーロードのドキュメントを自動的に複製します。（GhostDocに似ていますが、はるかに強力で構成可能なドキュメントジェネレータです）。

于 2011-06-08T22:43:28.340 に答える