c#如何使用 XML 文档功能
下面的示例提供对某个已存档类型的基本概述。
示例
//Ifcompilingfromthecommandline,compilewith:-doc:YourFileName.xml //////Classlevelsummarydocumentationgoeshere. /// //////Longercommentscanbeassociatedwithatypeormemberthrough ///theremarkstag. /// publicclassTestClass:TestInterface { //////StorefortheNameproperty. /// privatestring_name=null; //////Theclassconstructor. /// publicTestClass() { //TODO:AddConstructorLogichere. } //////Nameproperty. /// //////Avaluetagisusedtodescribethepropertyvalue. /// publicstringName { get { if(_name==null) { thrownewSystem.Exception("Nameisnull"); } return_name; } } //////DescriptionforSomeMethod. /// ///Parameterdescriptionforsgoeshere. /// ///Youcanusethecrefattributeonanytagtoreferenceatypeormember ///andthecompilerwillcheckthatthereferenceexists. /// publicvoidSomeMethod(strings) { } /// ///Someothermethod. /// //////Returnvaluesaredescribedthroughthereturnstag. /// //////Noticetheuseofthecrefattributetoreferenceaspecificmethod. /// publicintSomeOtherMethod() { return0; } publicintInterfaceMethod(intn) { returnn*n; } /// ///Theentrypointfortheapplication. /// ///Alistofcommandlinearguments. staticintMain(System.String[]args) { //TODO:Addcodetostartapplicationhere. return0; } } /// ///Documentationthatdescribestheinterfacegoeshere. /// //////Detailsabouttheinterfacegohere. /// interfaceTestInterface { //////Documentationthatdescribesthemethodgoeshere. /// //////Parameternrequiresanintegerargument. /// /// ///Themethodreturnsaninteger. /// intInterfaceMethod(intn); }
该示例生成一个包含以下内容的.xml文件。
xmlsample Classlevelsummarydocumentationgoeshere. Longercommentscanbeassociatedwithatypeormemberthrough theremarkstag. StorefortheNameproperty. Theclassconstructor. Nameproperty. Avaluetagisusedtodescribethepropertyvalue. DescriptionforSomeMethod. Parameterdescriptionforsgoeshere. Youcanusethecrefattributeonanytagtoreferenceatypeormember andthecompilerwillcheckthatthereferenceexists. Someothermethod. Returnvaluesaredescribedthroughthereturnstag. Noticetheuseofthecrefattributetoreferenceaspecificmethod. Theentrypointfortheapplication. Alistofcommandlinearguments. Documentationthatdescribestheinterfacegoeshere. Detailsabouttheinterfacegohere. Documentationthatdescribesthemethodgoeshere. Parameternrequiresanintegerargument. Themethodreturnsaninteger.
编译代码
若要编译该示例,请输入以下命令:
cscXMLsample.cs/doc:XMLsample.xml
此命令创建XML文件XMLsample.xml,可在浏览器中或使用TYPE命令查看该文件。
可靠编程
XML文档以///开头。创建新项目时,向导会放置一些以///开头的行。处理这些注释时存在一些限制:
1.文档必须是格式正确的XML。如果XML格式不正确,则会生成警告,并且文档文件将包含一条注释,指出遇到错误。
2.开发人员可以随意创建自己的标记集。有一组推荐的标记。部分建议标记具有特殊含义:
- 标记用于描述参数。如果已使用,编译器会验证该参数是否存在,以及文档是否描述了所有参数。如果验证失败,编译器会发出警告。
- cref属性可以附加到任何标记,以引用代码元素。编译器验证此代码元素是否存在。如果验证失败,编译器会发出警告。编译器在查找cref属性中描述的类型时会考虑所有using语句。
标记由VisualStudio中的IntelliSense用于显示有关某个类型或成员的附加信息。
备注
XML文件不提供有关该类型和成员的完整信息(例如,它不包含任何类型信息)。若要获取有关类型或成员的完整信息,请将文档文件与对实际类型或成员的反射一起使用。
以上就是c#如何使用XML文档功能的详细内容,更多关于c#使用XML文档功能的资料请关注毛票票其它相关文章!
声明:本文内容来源于网络,版权归原作者所有,内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:czq8825#qq.com(发邮件时,请将#更换为@)进行举报,并提供相关证据,一经查实,本站将立刻删除涉嫌侵权内容。