This project has moved and is read-only. For the latest updates, please go here.

Extracting summary and remark comments within methods

Topics: User Forum
Nov 8, 2006 at 11:51 PM
I am able to successfully build my help documentation through the SandCastle GUI (version I have noticed that only comments preceding the method name for example is captured in the generated help docs; however, the comments inside the method is not. Has anyone else encountered this and know a way around this via a toggle in the GUI or in the sandcastle.config file? thanks in advance.
Nov 9, 2006 at 2:47 AM
XML comments (those starting with ///) are the only kind captured and they are only valid on class and class member declarations. Comments inside of a method body will not be included. If you want them in the help file, put them with the other comments in a <summary> or <remarks> tag outside the method body.

Nov 9, 2006 at 3:00 PM
I see, thanks Eric.