問題タブ [xml-documentation]
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# - 参照として追加された場合、アセンブリに概要が表示されない
C# で「クラス ライブラリ」を作成しました。これには、概要 (XML ドキュメント コメント) を含む多くの関数があります。
例えば
同じ名前空間で関数を使用すると、概要が表示されますが、他のワークスペース(ソリューション)で参照として追加すると、概要が表示されません。
参照として追加した場合、他のソリューションで表示するにはどうすればよいですか?
.net - Ctrl + スペースを押すと Visual Studio でドキュメントが表示される
何らかの理由で、.net ライブラリのドキュメントしか表示されません。自分自身またはサード パーティのドキュメントを Visual Studio で表示する方法はありますか?
Visual Studio 2010 で ctrl+space を押したときにドキュメントを表示できるかどうかを知りたいです。Eclipse で慣れているものと同様です:)。または、少なくともメソッドまたはクラスをクリック (選択) して、何らかのビュー (ウィンドウ) でドキュメントを表示できるようにするときは?
msdn - C# XML ドキュメントのコメントから MSDN/公式ドキュメントにリンクするにはどうすればよいですか?
クラスに次のような XML コメントがあるとします。
フレームワークのドキュメントの適切なページへの参照System.Threading.Thread.CurrentPrincipal
とリンクを取得するにはどうすればよいですか?System.Web.HttpContext.User
c# - Xmlドキュメントのcref用のVisualStudioIntellisense
Visual StudioでC#メソッドのXMLドキュメントを作成すると(私は2010を使用しています)、see、paramrefなどのさまざまなXMLタグを作成するためのIntellisenseサポートを受け取ります。一方、aacref属性を追加するとタイプを記述するために複雑な形式であると私が思うものを使用する必要があります。これは、ジェネリックが多数ある場合に最悪です。
私が探しているのは次のとおりです。see要素でcref属性を設定している場合は、これまでに入力したものと一致するクラスのIntellisenseリストがあり、必要な適切な型の説明を出力します。または、paramref要素にcref属性を設定すると、そのメソッドのパラメーターのリストを受け取ります。
これらのcref属性にIntellisenseを提供するためのVisualStudioへのある種のアドオンを知っている人はいますか?
c# - C# xml ドキュメント: ノートの作成方法
私自身のドキュメントのこの MSDN ページの備考セクションにある黄色の「注:」ボックスと同様のことを実現したいと考えています。
私はサンドキャッスルとサンドキャッスル ヘルプ ファイル ビルダーを使用して、ドキュメント タグからリファレンス Web サイトを生成しています。そのようなメモボックスを実現するには、何を書かなければなりませんか?
c# - Sand Castle/MAMLのコードサンプルでクラス名を色付けするにはどうすればよいですか
クラス参照用のドキュメントを生成するために、nDocからSandCastleに移行しています。nDocは.net2.0をサポートしておらず、他にも多くの制限があります。
以前、nDocを使用すると、クラス名の強調表示など、コードに素敵な色を適用することができました。
たとえば、異なる色でConsole.WriteLine(something)
表示Console
されます(nDocではHTMLスタイルをXMLで直接指定できるため)。
ただし、Sand Castle(MAML)は型名を無視しているようです(実際のC#コードのみを受け入れ、色付けのHTML属性は許可されておらず、色付けはSand Castle自体によって実行されます)。最終的には、キーワード、コメント、定数のみが色付けされます。タイプ名も色付けされるようにこれを修正できますか?ありがとう!
以下は、私がnDocで持っていたものと、Sand Castleで複製する必要があるものです(MailMessage
、Pop3
およびConsole
が強調表示されています)。
c# - ジェネリック クラスのコンストラクターにコメントを付ける適切な方法は何ですか?
これにコメントする適切な方法は何ですか?
VSはそれについて不平を言います:
警告 11 'Data.Repository.Repository(Data.IUnitOfWork)' の XML コメントには、解決できなかった cref 属性 'Repository' があります C:\Projects\xx\yy\DataAccess\Repository.cs 35 58 データ
c# - doxygen を使用して XML コメントを含む既存の C# コードのドキュメントを作成する
私は、doxygen が C# コードのドキュメントを生成するための方法であることをどこでも読んできました。最初にドキュメント化したいインターフェースが 1 つあり (ベイビー ステップ)、そこには既に XML コメント (///) が含まれています。
これらのコメントはすでにサポートされているという膨大な数の投稿や情報 (doxygen.org を含む) があるため、doxywizard を実行すると、「警告: 化合物会社::製品::MyInterface は文書化されていません」。
これは、私が何らかの形で XML ドキュメントを誤解したか ( MSDNによれば、私が正しいことを話しているのではないことを願っています)、または doxywizard の構成を誤っていると思わせます。
最初に [ウィザード] タブから doxywizard を実行し、C#/Java をサポートすることを指定しました。実行すると、おそらく前述の警告が原因で、HTML ページが空白になります。次に、[エキスパート] タブで 1 つのファイルを指定して、もう一度実行しました - 同じ動作です。
doxygen で HTML を生成するために欠落しているスイッチまたは設定を誰か教えてもらえますか?
ドキュメント化されたプロパティ/メソッドが私のインターフェイスでどのように見えるかの例を次に示します。
次のように、インターフェイスの上にコメントがあります。
c# - C#.NETドキュメントに改行を追加する方法
これはもっと簡単なはずです...
コードのXMLドキュメントに「コード化された」改行を追加したい
ご覧のとおり、<と>の括弧を追加することを示すいくつかの回答を見つけました。興味深いことに、適切な'ol <br />改行は、Intellisenseポップアップに改行を作成しません。
これは面倒だと思います...
助言がありますか?