mdoc - 云端在线

程序：

您的姓名

mdoc - Mono 文档管理工具

概要

doc文件 命令 [选项[ARGS]

产品详情

doc文件 是一个基于程序集的文档管理系统。

doc文件 允许创建和更新文档 存根 根据内容
集会。 它不依赖于源代码中的文档。

优点是：

* 代码 可读性。 好的文档通常是 (a) 冗长，和 (b) 填写
用例子。 （为了比较，比较 Microsoft .NET Framework 文档，
这通常是每个成员的一页或更多文档，到 JavaDoc 文档，
这通常可以是每个成员的句子。）

在源代码中插入好的文档经常会使源代码膨胀
文件，因为文档可能比正在使用的实际方法更长
记录下来。

* 本土化。 源内文档格式（例如 CSC / DOC) 没有支持
用于多种人类语言。 如果您需要支持不止一种人类语言
用于文档目的， doc文件 很有用，因为它允许每种语言的输出
驻留在它自己的目录中，并且 doc文件 可以为每个单独的添加类型/成员
文档目录。

* 行政。 有单独的文档和开发并不罕见
团队。 也有可能文档团队的经验很少
与正在使用的编程语言。 在这种情况下，内联
文档是不可取的，因为文档团队可能会无意中插入
更新文档时源代码出错。 或者，你
为了安全起见，可能不希望文档团队访问源代码
原因。 doc文件 允许保留文档 完全 分开的和截然不同的
来自用于创建程序集的源代码。

可以使用 doc文件 更新 命令：

mdoc update -o docs/en 项目名称.dll

一旦生成了文档存根（希望以后用
实际文档），共有三种查看文档的方式：

* 要生成 HTML 页面的简单目录（每种类型一个 HTML 文件），请使用 doc文件
导出-html:

mdoc 导出 html -o /srv/www/htdocs/ProjectName docs/en

* 要使用 ASP.NET webapp 来显示源，请参阅： http://anonsvn.mono-
project.com/source/trunk/monodoc/engine/web/.

从 单证 源结帐，您可以这样做：

光盘引擎
制作网页

这将使用 xsp(1) 服务于ASP.NET webapp； 访问 http://localhost：8080 / 至
查看文档。

* 要使用 单证(1) 文档浏览器，你必须先 聚集 这些因素包括原料奶的可用性以及达到必要粉末质量水平所需的工艺。
说明文件：

mdoc assemble -o 项目名称 docs/en

上面的命令创建文件 项目名称.tree 和 项目名称.zip。 一个
额外 项目名称.sources 必须提供描述文件中的位置的文件
帮助系统文档应该被连接起来； 它是一个非常简单的 XML 文件，
喜欢这个：



<source provider="ecma" basefile="ProjectName"
路径=“各种”/>


上面的配置文件描述了文档是ECMA格式的，
基本文件名是 项目名 并且它应该连接在
“各种各样的” 文档树的一部分。 如果要查看各个节点
在文档中定义，您可以查看 单文件.xml 文件是
通常安装在 /usr/lib/monodoc/monodoc.xml.

一旦您拥有所有必需的文件（.zip、.tree 和 .sources），您就可以安装
使用以下命令将它们导入系统：

cp 项目名称.tree 项目名称.zip 项目名称.source \
`pkg-config monodoc --变量sourcedir`

以上将文件复制到Monodoc已经注册的目录中； 你
可能需要 root 权限才能执行此操作。 实际目录由
包配置 调用。

多媒体文档 指令

doc文件 聚集
编译文档以供在 单证(1) 浏览器。

查看 mdoc-汇编(1) 手册页了解详细信息。

doc文件 导出-html
将文档导出到 HTML 文件的目录结构中。

查看 mdoc-导出-html(1) 手册页了解详细信息。

doc文件 导出-msxdoc
将文档导出到单个文件中 Microsoft XML 文件记录 格式。

查看 mdoc-导出-msxdoc(1) 手册页了解详细信息。

doc文件 帮助
查看给定命令的内部帮助。

mdoc 帮助组装

等效于：

mdoc 汇编 --help

可以一次列出多个子命令：

mdoc 帮助组装 export-html 更新验证

doc文件 更新
更新文档，根据参考程序集添加和删除成员。

查看 mdoc-更新(1) 手册页了解详细信息。

doc文件 验证
根据 Mono 文档架构验证文档。

查看 mdoc-验证(1) 手册页了解详细信息。

使用 onworks.net 服务在线使用 mdoc