5

公開されている関数とプロパティの一部のAPIを作成するために、今日初めてHelpBuilderGUIでSandCastleを使用しています。/// <summary> ... </summary追加のドキュメントや使用例の恩恵を受けると感じたいくつかのプロパティに含めました。

chmに出力ファイルを作成すると、要約の説明がまったく表示されません。すべてのプロパティメンバーが一覧表示されますが、説明は空白です。プロジェクトを再構築し、SandCastleでいくつかの異なる設定を試しましたが、まだ表示されません。

私が見落としている明らかなものはありますか？SandCastleはプロパティの概要を読みませんか？または、要約に別のキーワードが必要ですか？

4

3 に答える 3

7

コンパイル時にXMLドキュメントファイルを生成するようにVisualStudioに指示する必要があります。http： //msdn.microsoft.com/en-us/library/vstudio/x4sa0ak0（v = vs）で説明されているように、対応するプロジェクトプロパティを設定するだけです。 100）.aspx

その後、Sandcastleは「説明」列に「要約」コメントを出力します。

于 2014-10-10T12:40:57.723 に答える
3

Sandcastleの一般的な問題のヘルプページから：

ドキュメントにコードコメントがありません

デフォルトでは、プロジェクトのすべてのXMLドキュメントは、comments.xmlという名前の単一のファイルに含まれていると想定されています。複数のXMLドキュメントファイルがある場合は、次の例のように、Commentsという名前の新しいフォルダーに配置し、代わりにワイルドカードを使用するようにsandcastle.configを調整します。

<!-- Copy in comments -->
<component type="Microsoft.Ddue.Tools.CopyFromIndexComponent"
           assembly="%DXROOT%\ProductionTools\BuildComponents.dll">
  <index name="comments" value="/doc/members/member"
         key="@name" cache="100">
    <data base="%SystemRoot%\Microsoft.NET\Framework\v2.0.50727"
          recurse="false" files="*.xml" />

    <data files="Comments\*.xml" />  <!-- This line was modified -->

  </index>
  <copy name="comments" source="*" target="/document/comments" />
<components>

詳細については、このブログ投稿を参照してください。

于 2012-06-07T20:11:41.517 に答える
0

別の回答がすでに機能していると認められているようですが、同じ問題が発生したため、別の理由で解決策を追加します。

ドキュメントソースとして使用しているXMLファイルを開いた場合は、コメントを書き込んだものの、最終的なサンドキャッスルドキュメントに表示されていないメソッド/プロパティを管理します。メッセージが表示された場合：

メンバー"M：..。の不正な形式のXMLコメントは無視されます

次に、私のように、XMLがあまり満足していない文字をいくつか含めたと思います。コメントに「＆」を使用しましたが、「<」または「>」も使用するとXMLが怒鳴ります。コメントを修正してください。

于 2015-06-12T16:27:17.543 に答える