Shulou(Shulou.com)06/02 Report--

Today, I would like to share with you the relevant knowledge of what the common problems of VS XML comments plug-ins are, the content is detailed, and the logic is clear. I believe most people still know too much about this knowledge, so share this article for your reference. I hope you can get something after reading this article.

These manual tags are very useful, and if they are set properly, they will be very helpful for exporting to external documentation. If it is a predefined xml tag, the compiler can output these comments as text; if it is a xml tag that the compiler does not know, the compiler will output everything word for word, which means you can use your own defined tags.

With appropriate settings, the C # compiler does not format VS XML comments, but outputs them as xml files. The following steps demonstrate how to get the C # compiler to output VS XML comments to a xml file. Right-click the project item in solution Explorer, open the project's property page, and click Properties. When the dialog box appears, click the configuration properties directory. Click the build node.

In the box on the right, there is the output-- the xml document file, which is the file name of the xml file generated by setting the cluster VS XML comments. (note: the relative path is set here, not the absolute path). In my example, I use GiveHelpDoc.xml as the document name, which will be the default setting if no value is entered here.

Generally accepted tags I classify VS XML comment tags into two categories: * classes are set tags, and I call them main tags. They are at the beginning of a set of tags and do not appear inside the tags. The second category is to set the tags that tags contain, and I ask them to support tags. The difference between the support tag and the html tag is that the support tag is lowercase and the html tag is uppercase, showing the support tag and the main tag that I will discuss.

Part of the GiveHelpTransforms.cs code:

Namespace GiveHelp

{

Class that contains functions to do transformations to help files.

The source XML is loaded into the property

(e.g. Obj.SourceXML = "XML goes here"). One of

The associated member functions (,)

Is called to initiate and then return the transformation.

Help Page

Function to call

List of Types

GiveTypeListHTMLHelp

List of members

GiveMemberListHTMLHelp

Help for a single member

GiveMemberHTMLHelp

Public

/ / create the class that does translations

GiveHelpTransforms ght = new GiveHelpTransforms ()

/ / have it load our XML into the SourceXML property

Ght.LoadXMLFromFile ("E:\\ Inetpub\\ www-

Root\\ GiveHelp\\ GiveHelpDoc.xml ")

/ / do the translation and then write out the string

Response.Write (ght.

GiveMemberHTMLHelp (Request.QueryString.Get ("Type")

Request.QueryString.Get ("Member")

Public class GiveHelpTransforms

{

These are all the contents of the article "what are the common questions of VS XML comment plug-ins". Thank you for reading! I believe you will gain a lot after reading this article. The editor will update different knowledge for you every day. If you want to learn more knowledge, please pay attention to the industry information channel.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.