几点建议
Opened this issue · 6 comments
能否将example部分输出为代码形式？
能否支持yuidoc各个参数的支持，特别是 server 参数，要不然每次都要手动执行一次。
你好，很感谢你的建议，不过我想具体问下：
要将example输出成代码是有什么样的需求呢？现在已经是有@demo来直接指向代码文件了啊。
核心还是用yuidoc，参数设置的都是一样的，smartdoc只是做了一些扩展；另外请问下，你说的server参数是指什么，有点不太清楚。
@zhh77 这里说的example是指yuidoc里的example，比如怎么调用当前方法。如
get(a,b,c);
或者返回的json格式数据
{
status:1
msg:''
}
等等，指的是调用示例或者一些说明性的代码片段，不需要完整的demo文件。
@demo指向的是代码文件，而且这里我在没有demo的时候能否不要显示查看demo和编辑代码的按钮，是否支持demo能否加个参数。
参数指的是命令行参数。比如
yuidoc -h
这个命令行输入进去会列出所有的帮助。
smartdoc貌似只有一个smartdoc，执行了就是根据配置文档直接生成文档。
yuidoc --server <port>
server 参数会起一个web服务，可以直接在浏览器里访问，而且在文件有修改的时候会自动实时生成文档，方便立即查看效果，而且也可以比较方便的直接提供给其他人查看。
smartdoc在命令行方面目前没看到。
还有就是
Methods
Properties
Events
这3个能否不要放在同一行，每一个单独一行，在没有的情况下就直接不要显示出来，有时候一页里只有Methods的时候，其他2个全部空在那里一个是占位不好看，另一个Methods就显得很拥挤，也buli不利于查看。
这一点在0.1.0的时候的版貌似还不错，而且0.1.0的时候example部分也是作为代码显示的。
好的，多谢你的反馈，
- example现在好像也会输出成代码的的，不过好像与@demo不能同时使用，后面我也在修改下；
- 命令这部分，前面的确没有考虑到，后面我也调整一下。
- 另外后续版本会计划走更加轻量级的方式，输出更加简单的结构，类似于gitdoc；
最好能够全面支持yuidoc的所有命令，在这个基础上如果有必要的话可以增加一些，这样子从yuidoc切换过来的话比较无痛一点。
配置文件如果能直接支持yuidoc的配置文件的话也最好，而且感觉配置文件用
.json
扩展的文件比较好，grunt、bower等等这些都用.json作为后缀的文件作为配置文件。
.js的话在nodejs下感觉应该是作为可以执行的内容，而不是静态配置。
本来是想直接用yuidoc的，不过自带的主题不好，第三方主题也很稀缺，而且也都不是很好，看到smartdoc感觉不错，希望能越来越好吧。