gt ltexceptio A.2.4 标识方法可能引发的异常 ngt ltincludegt A.2.5 包括来自外部文件的 XML ltlistgt A.2.6 创建列表或表 ltparagt A.2.7 用于将结构添加到文本中 ltparamgt A.2.8 描述方法或构造函数的参数 ltparamre A.2.9 确认某个单词是参数名 fgt ltpermissi A.2.10 描述成员的安全性和访问权限 ongt ltsummar A.2.11 描述一种类型 ygt ltreturnsgt A.2.12 描述方法的返回值 ltseegt A.2.13 指定链接 ltseealso A.2.14 生成“请参见”项 gt ltsummar A.2.15 描述类型的成员 ygt ltvaluegt A.2.16 描述属性 A.2.1.ltcgt 此标记提供一种机制以指示用特殊字体(如用于代码块的字体)设置说明中的文本段落。
对于实际代码行,请使用 ltcodegt(第 A.2.2 节)。
语法: ltcgttextlt/cgt 示例: /// ltsummarygtClass ltcgtPointlt/cgt models a point in a two-dimensional /// plane.lt/summarygt public class Point // ... A.2.2.ltcodegt 此标记用于将一行或多行源代码或程序输出设置为某种特殊字体。
对于叙述中较小的代码段,请使用 ltcgt(第 A.2.1 节)。
语法: ltcodegtsource code or program outputlt/codegt 示例: /// ltsummarygtThis method changes the points location by /// the given x- and y-offsets. /// ltexamplegtFor example: /// ltcodegt /// Point p new Point35 /// p.Translate-13 /// lt/codegt /// results in ltcgtplt/cgts having the value 28. /// lt/examplegt /// lt/summarygt public void Translateintxor intyor X xor Y yor A.2.3.ltexamplegt 此标记用于在注释中插入代码示例,以说明如何使用所关联的方法或其他库成员。
通常,此标记是同标记 ltcodegt(第 A.2.2 节)一起使用的。
语法: ltexamplegtdescriptionlt/examplegt 示例: 有关示例,请参见ltcodegt(第 A.2.2 节)。
A.2.4.ltexceptiongt 此标记提供一种方法以说明关联的方法可能引发的异常。
语法: ltexception crefquotmemberquotgtdescriptionlt/exceptiongt 其中 crefquotmemberquot 成员的名称。
文档生成器检查给定成员是否存在,并将 member 转换为文档文件 中的规范元素名称。
description 对引发异常的情况的描述。
示例: public class DataBaseOperations /// ltexception crefquotMasterFileFormatCorruptExceptionquotgtlt/exceptiongt /// ltexception crefquotMasterFileLockedOpenExceptionquotgtlt/exceptiongt public static void ReadRecordint flag if flag 1 throw new MasterFileFormatCorruptException else if flag 2 throw new MasterFileLockedOpenException // … A.2.5.ltincludegt 此标记允许包含来自源代码文件外部的 XML 文档的信息。
外部文件必须是符合标准格式的 还可以将 XPath 表达式应用于该文档来指定应包含该 XML 文档中的哪些 XML 文XML 文档,本。
然后用从外部文档中选定的 XML 来替换 ltincludegt标记。
语法: ltinclude filequotfilenamequot pathquotxpathquot /gt 其中 filequotfilenamequot 外部 XML 文件的文件名。
该文件名是相对于包含 include 标记的文件进行解释 的(确定其完整路径名)。
pathquotxpathquot XPath 表达式,用于选择外部 XML 文件中的某些 XML。
示例: 如果源代码包含了如下声明: /// ltinclude filequotdocs.xmlquot pathextradoc/classnamequotIntListquot/ /gt public class IntList … 并且外部文件“docs.xml”含有以下内容: ltxml versionquot1.0quotgt ltextradocgt ltclass namequotIntListquotgt ltsummarygt Contains a list of integers. lt/summarygt lt/classgt ltclass namequotStringListquotgt ltsummarygt Contains a list of integers. lt/summarygt lt/classgt lt/extradocgt 这样输出的文档就与源代码中包含以下内容时一样: /// ltsummarygt /// Contains a list of integers. /// lt/summarygt public class IntList … A.2.6.ltlistgt 此标记用于创建列表或项目表。
它可以包含 ltlistheadergt 块以定义表或定