【问题标题】:framework for showing style guide [closed]显示风格指南的框架[关闭]
【发布时间】:2014-09-09 17:23:42
【问题描述】:

在我的项目中,我们计划开发一个可重复使用的组件列表。

如何为我们的函数生成类似于开源框架(例如 JQuery)提供的格式化文档。

【问题讨论】:

  • 我不明白这个问题。
  • 在引导程序中,主干显示文档如何正确使用现有的类或函数,我需要为我的项目创建相同的。那么有什么工具可以创建相同的。
  • 是的,它叫做 HTML。
  • 是否有任何预定义的开源工具,以便我可以将我的代码集成到其中以使我的工作更轻松。
  • 我不这么认为,但应该不会太难,只需为导航创建一个基本网站和每个功能的许多小页面,然后从您的主站点调用这些页面使用 ajax

标签: javascript html document


【解决方案1】:

看看YUIDoc JSDoc。我想这就是你所追求的。

这里是一个帖子的链接,它收集了更多信息:

Documenting your open source projects

【讨论】:

  • 谢谢尼克。这是我所期望的。