这是命令 naturaldocs 可以使用我们的多个免费在线工作站之一在 OnWorks 免费托管服务提供商中运行,例如 Ubuntu Online、Fedora Online、Windows 在线模拟器或 MAC OS 在线模拟器
程序:
您的姓名
NaturalDocs - 一个可扩展的多语言文档生成器
概要
自然文档 -一世[-一世...] -o
格式> [-o ...] -p
目录> [选项]
商品描述
本手册页简要记录了 .B naturaldocs 命令。 注意 自然文档 是一个
在 Debian 上调用真正的包装器脚本 自然文档 perl 程序。 所以,真正的,
该程序的原始名称是 NaturalDocs 但在 Debian 系统上您将其调用为
自然文档。
自然 文档 is 是一个开源的、可扩展的、多语言的文档生成器。 你
用读起来像普通英语的自然语法记录你的代码。 自然文档然后
扫描您的代码并从中构建高质量的 HTML 文档。
配置
从打印的帮助中提取的选项摘要 -h 开关包含在下面。
有关 NaturalDocs 工作原理的完整说明,请参阅
/usr/share/doc/naturaldocs 目录。
其他要求 参数:
-一世, - 输入, - 来源 DIR
指定输入(源)目录。 必需的。
可以多次指定。
-o, - 输出 FMT DIR
指定输出格式和目录。 必需的。
可以指定多次,但每个目录只能指定一次。 可能的输出
格式是 HTML 和 FramedHTML。
-p, - 项目 DIR
指定项目目录。 必需的。
每个源目录都需要有一个唯一的项目目录。
可选 参数:
-是的, - 风格 风格 [风格 ...]
指定构建 HTML 输出时的 CSS 样式。 如果有多种样式
指定,它们都将包含在给定的顺序中。
-img, - 图片 DIR
指定图像目录。 可以多次指定。 从...开始 * 至
指定一个相对目录,如 -img */images。
-做, --只记录
指定只应在输出中包含记录的代码方面。
-t, --tab-长度 LEN
指定应扩展到的空格数。 这只需要
设置是否在示例代码和文本图中使用选项卡。 默认为 4。
-xi, --排除输入, --排除源
从文档中排除输入(源)目录。 自动完成
项目和输出目录。 可以多次指定。
-唠叨, --无自动组
完全关闭自动分组。
- 经常, --only-文件标题
源文件将仅使用文件名作为标题。
-r, - 重建
从头开始重建所有输出和数据文件。 不影响菜单文件。
- 罗, --重建输出
从头开始重建所有输出文件。
-q, - 安静的
禁止所有非错误输出。
-?, -H, - 帮帮我
显示语法参考。
使用 onworks.net 服务在线使用自然文档