一款基于 Xml 的 API 文档生成器。
可以将特定标记的 Xml 文档转为 Html 文档。
主要用于 VS 自动生成的 Xml 文档解析，可以适用于 C# 文档生成。
| 标记 | 属性 | 作用 |
|---|---|---|
<summary> |
—— | 添加关于类型或成员的信息摘要 |
<remarks> |
—— | 补充关于 <summary> 标记提供的类型或成员的信息 |
<returns> |
—— | 描述方法声明的返回值 |
<example> |
—— | 包含一个示例代码，示例内容用 <code> 标记 |
<para> |
—— | 将文本分成段落 |
<c> |
—— | 将部分文本标记为代码 |
<exception> |
cref |
描述异常，属性描述异常引用 |
<see> |
cref |
创建超链接，导向其他成员，属性描述链接位置 |
<seealso> |
cref |
类似 <see> ，一般跟在其后，表示另见 |
<param> |
name |
描述方法的参数，参数名在属性内指出 |
<typeparam> |
name |
描述泛型方法的参数，参数名在属性内指出 |
<list> |
—— | 用于生成列表,用<term>表示项，<description>表示描述 |
因为本人不善前端，以至于做出的网页较为尴尬。你可以去往documentgenerator\XMLToDocument\data\style目录下修改相关文件。其中：
main.xsl表示入口页面。member.xsl表示成员页面。navigation.xsl表示导航栏。