Geek asks and answers

Sandcastle does not document property summary

I am using SandCastle with the HelpBuilder GUID for the first time today to help create the APIs for some of our public functions and properties. I have included /// <summary> ... </summaryin a number of properties where, in my opinion, they will receive additional documentation or examples of use.

When I create the output file in chm, I don’t see any summary descriptions at all. All property items are listed, but their descriptions are empty. I rebuilt the project and tried several settings in SandCastle, but they still do not appear.

Is there something obvious that I don't notice? Does SandCastle notice a property summary? Or do you need a resume for another keyword?

+5
source share
3 answers

Sandcastle :

, XML comments.xml. XML, "" sandcastle.config wild card, .

<!-- 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>

. .

+3

Visual Studio XML : , : http://msdn.microsoft.com/en-us/library/vstudio/x4sa0ak0(v=vs.100).aspx

Sandcastle "" "".

+5

, , , , .

XML, , control-f - /, , sandcastle. :

XML "M:...

, , , , , XML . "&". , XML , "<" " > ". , !

0

More articles:


All Articles