文件名称：commandbox-cfc-to-markdown-docs:CommandBox自定义命令，用于从CFC生成降价文档
文件大小：9KB
文件格式：ZIP
更新时间：2024-04-21 05:40:25
ColdFusion
CommandBox CFC到Markdown文档 一个CommandBox定制命令，用于从您的CFC生成降价文档。 套件安装 您需要安装才能使用此工具。 如果您的，请参阅底部的注释。 从终端内部，只需运行以下命令即可安装模块。 box install commandbox-cfc-to-markdown-docs 安装模块后，它将使用以下命令： markdowndoc或别名mdd 。 它能做什么 运行命令markdowndoc path/to/your/file.cfc读取/分析组件元数据为您file.cfc并使用此生成一个降价的文档文件。 它忽略属性和私有方法。 该文档来自您的javadoc样式注释。 特别地， @hint用于主文档和@doc用于向外部文档的参考。 您可以使用@arguementName注释为函数参数提供其他提示。 例子 您可以看到一个如何在使用此命令的示例。
【文件预览】：
commandbox-cfc-to-markdown-docs-main
----README.md(3KB)
----CHANGELOG.md(813B)
----LICENSE(1KB)
----box.json(2KB)
----ModuleConfig.cfc(483B)
----commands()
--------markdowndoc.cfc(9KB)
----templates()
--------apiwrapper.cfm(273B)
--------layouts()
--------default.cfm(272B)