CFMLDoc插件
Sublime 2/3插件,用于在CFML(标签和脚本)中生成JavaDoc/YUIDoc风格的注释
详细信息
安装数量
- 总数 2K
- Windows 2K
- Mac 351
- Linux 150
8月6日 | 8月5日 | 8月4日 | 8月3日 | 8月2日 | 8月1日 | 7月31日 | 7月30日 | 7月29日 | 7月28日 | 7月27日 | 7月26日 | 7月25日 | 7月24日 | 7月23日 | 7月22日 | 7月21日 | 7月20日 | 7月19日 | 7月18日 | 7月17日 | 7月16日 | 7月15日 | 7月14日 | 7月13日 | 7月12日 | 7月11日 | 7月10日 | 7月9日 | 7月8日 | 7月7日 | 7月6日 | 7月5日 | 7月4日 | 7月3日 | 7月2日 | 7月1日 | 6月30日 | 6月29日 | 6月28日 | 6月27日 | 6月26日 | 6月25日 | 6月24日 | 6月23日 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 1 | 1 | 0 | 0 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 1 | 1 | 1 | 1 | 0 | 0 | 1 | 1 | 0 | 0 | 1 | 0 | 0 | 2 | 1 | 1 | 2 | 0 | 0 | 0 | 1 | 1 | 1 | 1 | 1 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | 0 |
Mac | 1 | 3 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 1 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
说明文档
- 源代码
- raw。
cfmldocplugin - 版本 0.1.3
一个Sublime插件,用于在CFML中生成CFDoc注释(标签和脚本)
简单直接,您只需安装插件并设置快捷键。
运行它将基于您的CFML代码创建CFDoc风格的注释。
虽然它可以自动提取代码信息,但它并不是真的有先见之明,所以要添加注释到头部,只需使用提示或描述即可!
例如:
public array function myAwesomeFunction( required string awesome, maybeAwesome = "totally" ) hint="My text here" {
return arguments.awesome;
}
变为:
/**
* My text here
*
* @method myAwesomeFunction
* @public
* @param {string} awesome (required)
* @param {any} [maybeAwesome = "totally" ]
* @return {array}
*/
public array function myAwesomeFunction( required string awesome, maybeAwesome = "totally" ) hint="My text here" {
return arguments.awesome;
}
输出的注释块相当标准,我在生成文档时测试了YUIDoc而不是JavaDoc,当然也测试了我即将发布的cfml文档生成器。
如果您发现任何错误,请告诉我,我将检查一下。
安装
在Sublime包管理器中通过CFMLDocPlugin安装
设置一个键转换为命令docifycfml,如下所示
{ "keys": ["ctrl+shift+2"], "command": "docifycfml" }