問題タブ [ghostdoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
c# - GhostDoc にインターフェースの実装を適切に文書化するにはどうすればよいですか?
私は 1 年前に Visual Studio 2015 で Ghostdoc Free を使用しましたが、その機能が非常に気に入り、購入することにしました。Visual Studio 2012 を使用する必要があり、クラスのコメントが以前ほど良くないことに気付きました。
それはただ言うだけです:
/// The ClassName class.
一方、次のようなインターフェイスを実装するクラスを区別する前に:
/// Implements the <see cref="IInterfaceName"
ルールを調べましたが、インターフェイスの名前を抽出する方法がわかりません。私は今これを持っています:
これにより、次のようになります。
/// Provides a class that implements a class name
クラス名を取得して分割するだけです。そして、/// Implementation of IInterfaceName
これは少し鈍いです(複数のインターフェースの場合)
ここにインターフェイス名を挿入する例はありますか?
visual-studio - Ghostdoc 'document this' ショートカットが機能しない
Visual Studio 2017 Community Edition V15.8.4 と、Marketplace で入手可能な最新の Ghostdoc バージョン (ビルド 2018.1.18330) を使用しています。
前回の更新以降、Ghostdoc は割り当てられたショートカットを認識しなくなりました。Ctrl+Shift+D 以外のショートカットが割り当てられるたびに、'document this' で Ghostdoc は、'Ghostdoc は、Document This に関連付けられたショートカットがないことに気付きました. Ctrl+Shift+D ショートカットを再割り当てしますか?'.
ショートカットがどのように割り当てられているかは問題ではありません (ツール => オプション => キーボードまたは Ghostdoc ショートカットの再割り当て)。何かを文書化するためにショートカットではなくメニューを使用すると、エラーもポップアップします。
試したショートカットは他の場所では使用されていません。また、Ghostdoc によって提案されたショートカットのいずれかを割り当てた場合にもエラーが発生します。
VS 2017 の Ghostdoc をアンインストールしても、アンインストールするオプションのない Ghostdoc コミュニティが残ります。無効にしても違いはなく、このエディションのみを使用して何かを文書化しようとすると、プロジェクトが明らかに完全にロードされた後でも、常に「アクションを実行できません。VS はまだプロジェクトをロードしています」と表示されます。
ショートカットを割り当てて [...Ctrl+Shift+D ショートカットを再割り当てしますか?] をキャンセルすると、ポップアップ、新しいショートカットでコメントすると実際に機能します。
なぜこれが起こっているのか、どうすれば修正できるのか、誰にもわかりません。そうでない場合、設定ファイルなどのどこかに手動でショートカットを追加することは可能ですか?