-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
几点建议 #3
Comments
你好,很感谢你的建议,不过我想具体问下: 核心还是用yuidoc,参数设置的都是一样的,smartdoc只是做了一些扩展;另外请问下,你说的server参数是指什么,有点不太清楚。 |
@zhh77 这里说的example是指yuidoc里的example,比如怎么调用当前方法。如
或者返回的json格式数据
等等,指的是调用示例或者一些说明性的代码片段,不需要完整的demo文件。 @demo指向的是代码文件,而且这里我在没有demo的时候能否不要显示查看demo和编辑代码的按钮,是否支持demo能否加个参数。 参数指的是命令行参数。比如
这个命令行输入进去会列出所有的帮助。
server 参数会起一个web服务,可以直接在浏览器里访问,而且在文件有修改的时候会自动实时生成文档,方便立即查看效果,而且也可以比较方便的直接提供给其他人查看。 smartdoc在命令行方面目前没看到。 还有就是 |
好的,多谢你的反馈,
|
最好能够全面支持yuidoc的所有命令,在这个基础上如果有必要的话可以增加一些,这样子从yuidoc切换过来的话比较无痛一点。 配置文件如果能直接支持yuidoc的配置文件的话也最好,而且感觉配置文件用 本来是想直接用yuidoc的,不过自带的主题不好,第三方主题也很稀缺,而且也都不是很好,看到smartdoc感觉不错,希望能越来越好吧。 |
@return 部分能否也改成输出成代码的,因为有时候返回是个对象,如果能输出成代码格式的话,就可以顺带把返回的代码也加上,看起来更直观明了。 如果时间不够的话项目里的模板能否单独提取出来一套,可以先用yuidoc跑,现在项目里的直接下载下来放进去执行有问题,缺少js。 |
恩,@return这块你直接使用markdown去输出代码也可以的。后面并不希望在注释中加入太多代码,会走更加轻量的模式。而代码的输出则是系统都是通过test case来提供; 最近比较忙,在搞另外一个项目,估计过段时间才有时间搞smartdoc。模板本来都是独立的,你指定下js的路径就好了,细节可以参考yuidoc的内容 |
能否将example部分输出为代码形式?
能否支持yuidoc各个参数的支持,特别是 server 参数,要不然每次都要手动执行一次。
The text was updated successfully, but these errors were encountered: