Insert or update XML Comment from Help Builder Topic

You can easily insert an XML Comment from a Help Builder topic by selecting a topic in Help Builder, and then selecting the method, property or event in the Visual Studio Editor. Help Builder then inserts or updates the XML Comment for the member in the Source Code.

Note for VB.NET users
VB.NET 2003 doesn't support XML Comments natively, but if you use a third party product that uses the VB.NET Whidbey style syntax (triple single quotes) Help Builder can read and write XML Comments in this format. The following examples show C# code, but the procedure for VB.NET code is identical.

To do this follow these steps:

• Bring up Help Builder from the Context or Help Menu's Show Help Builder option
  
• Select the topic you want to insert the Comment for. (#1)
  If you previously created a Help Builder topic will bring up this topic automatically.
  Otherwise navigate Help Builder to the topic you want to use.
  
• Select the class, method, property, field, event in the Source Code Editor. (#2)
  To do simply place the cursor anywhere within the method, property, field or event or in the XML Comment area if it exists.
  
• Right Click and Select Insert Xml Comment from Help Builder Topic (#3)
  
• Help Builder inserts the topic's content as an XML Comment (#4)
  

If there is an existing XML Comment block it is replaced by the output from this command.

To select a member in your Code you can place the cursor anywhere in the body of the member or any preceeding comment block. Note Visual Basic is a little more finicky and you may have to place the cursor on the actual member signature (method header, property) rather than the body or existing comment body.