代码之家 › 专栏 › 技术社区 › Hemant

使用MAML进行图书馆的概念文档[关闭]

maml wiki documentation .net c#

Hemant · 技术社区 · 15 年前

我正在开发一个新的库,我正在使用XML注释来编写API文档,以及Sandcastle,这非常有效。

但我需要编写额外的文档,包括概念、总体架构、工作演示等、类图等。

我有两个选择:

使用wiki似乎是安全的解决方案,因为有许多稳定的、流行的和免费的引擎可用,但API和概念文档将不会同时使用(交叉链接、外观等)。使用maml意味着一个学习曲线,我不确定它有多成熟,它的优点/缺点是什么。

你使用过maml/wiki吗?你学到了什么?你能给我什么建议?

1 回复 | 直到 15 年前

joshua.ewer 15 年前

就我个人而言,我喜欢在wiki上工作的自由。在这一点上,您有一些不错的选择来编辑maml

我不能对DocProject说太多(尽管它看起来不错)。现在,我正在使用SHFB将API文档和一些概念文档合并到MAML中。编辑很得体,足以满足我的需要。我可以轻松地建立一个目录,并在我的API和概念文档之间建立链接。一个很好的例子是 SandcastleStyles .

和所有事情一样,有一些重要的问题要问。

您是否有任何要求将您的文档放在一个包中? 在我的情况下,我需要把所有东西都装在一个好的编译包中。你不能用wiki做,但你可以用sandcastle做。
你是唯一一个更新概念内容的人吗? 大多数维基都有一个非常好的编辑,并且能够快速链接主题。编辑内容所需的唯一工具是浏览器,这可能是对技术不太熟练的作家的一项要求。