問題タブ [ghostdoc]

私はメソッドなどを文書化するためにGhostDocを使用しています...そしてうまく機能していますが、それは<returns>...

誰か私が何をすべきか教えてもらえますか

「ロール」というオブジェクトが返された場合

または単に

また

私はその音が少し正確すぎることを知っていますが、私は正しいことから始めたいです:-)

たとえば、ユーザー名の標準の文字列戻り値の型を考えてみましょう

メソッドで再実行するときに「変更者」行を追加するために、ゴーストドキュメントを取得してメソッド（ゴーストドキュメントによって作成された）の既存のXMLコメントを変更する方法はありますか？

個人的にはこれがソース管理の目的だと思いますが、彼らはそれを XML で行いたいと考えているため、これは新しい作業要件です。

完全な xml コメントを持つインターフェイス ( ISomeInterface) と、一致する xml コメントを持ついくつかの派生クラスがあります。

インターフェイスのコメントを変更した場合、すべての派生クラスのコメントを GhostDoc (またはその他のツール) で更新できますか?

これにより、一部のシナリオで不要な変更が発生する可能性があることを理解していますが、この場合は心配していません.

次のようなプロパティの属性のコメントを生成するように GhostDoc を構成するにはどうすればよいですか。

GhostDocsの要点は、明らかにコードを文書化することです。そのためには、メソッドに適切な名前を付けるように求められます。ただし、適切な名前のメソッドを使用すると、理論的には、ドキュメントと見なされるほど有用ではないでしょうか。

ダウンロードして不要で重複するドキュメントでコードを乱雑にしたくないので、現在のユーザーの賛否両論を聞きたいだけです。

C# の時代に戻って、"GhostDoc" という Visual Studio 拡張機能を使用するのが大好きでした。私はJava開発者として使用されているので、Eclipseを使用しています。推論されたドキュメンテーションがなくても生きていけますが、ドキュメンテーションを知的に「修正」したいと思っています。たとえば、次のメソッドがあるとします。

開発の後半で、メソッドのコンシューマーが qux 値を渡せるようにすると便利であることに気付きました。それだけでなく、最初のパラメーターとして使用するのが最も理にかなっています。また、このメソッドで非常に便利な FooBarException をスローするようにします。したがって、私の方法は次のようになります。

優れた開発者として、自分の変更を JavaDoc に反映させたいと思っています。GhostDoc では、ドキュメントのショートカット キーを押すと、古いものを邪魔することなく新しいものを追加できました。Eclipse では、JavaDoc のまったく新しいセットがレンダリングされるため、コピー パスタを大量に実行する必要があります。現在持っている JavaDoc を失うことなく、新しい@param、@exception、および不足しているパラメータを JavaDocに自動的に挿入するにはどうすればよいですか?@returns

GhostDoc Proの「ルール」設定内で、T4を使用してコメントをフォーマットできます。ただし、（私が整理した）改行をランダムに追加し、トリプルスラッシュの1行を追加することもできません。

例えば：

StringBuilder.Append（ "///"）;を追加してみました。3つのスラッシュを追加するだけで試してみました。ただし、GhostDoc Proは、空白のトリプルスラッシュコメント行を追加するT4またはC＃コードの行を削除しているようです。

シンプルなものを見落としているような気がします。

GhostDoc を次のようにカスタマイズするにはどうすればよいですか?

基本的に、コメントの先頭に著者を追加し、コメントの最後に日時を追加したいと考えています。

私は GhostDoc を使用して XML コメントを作成していますが、この形式には非常に満足しています。次の形式を使用します（c＃）

R# 7.1.1 のコード クリーンアップを使用して、xml コメントを再フォーマットし、欠落していた場所に新しい xml コメントを挿入することさえあり、本当に面倒です。これを止める方法はありますか。

コードのクリーンアップ用に独自のプロファイルを作成し、すべてを無効にしました (stylecop の設定も)。コードのクリーンアップを行ったところ、xml コメントを再フォーマットし、不足していた場所に新しいコメントを配置する必要があることを確認しました。

これを回避する方法を知っている人はいますか？

ありがとう

パブリックアクセサのみにコメントするように GhostDoc を設定するにはどうすればよいですか? 「ルール」構成を見てきましたが、アクセサ タイプを示す情報/変数は見当たりませんでした。