我们无需仔细研究可用于自定义此工具输出的选项(您可以在专用页面上了解更多信息),而是了解如何将此工具集成到您的工作中。
创建文档往往是一个漫长而乏味的过程,但这就是创建 SassDoc、JSDoc 或 PHPDoc 等解决方案的原因,它们能够自动化其中一些方面。我们唯一需要做的就是在开发代码时添加文档详细信息。
在这种情况下,我开的讨论。
假设我们是一个三人团队,您是Sass Master。您的任务是创建要在项目中使用的变量、函数和 mixins,您可以通过研究图形设计师给您的模型来推断这些变量、函数和 mixin。完成此操作后,您需要传递这些代码,并让实习生使用您提供的结构将模型组装成真实的网页。
您自己会很好地理解移交文件_variables.scss,_functions.scss但_mixins.scss通常这还不够,您的同事需要一些支持来了解如何使用您为他提供的设施。
事实上,并不总是能够提供这种类型的支持,而这正是像 SassDoc 这样的工 台湾数据 具真正有用的地方!
这个系统背后的逻辑非常简单,因为我们所要做的就是向代码中添加额外的注释,以便应用程序能够理解我们传递的信息。
SassDoc 不是一个会迷失在太多喋喋不休中的工具,事实上它允许我们立即工作,而不必在冗长的配置上浪费太多时间。在我的示例项目中(您也可以在我们的 GitHub 存储库上找到),Sass 文件结构如下:
SassDoc 不是一个会迷失在太多喋喋不休中的工具,事实上它允许我们立即工作,而不必在冗长的配置上浪费太多时间。在我的示例项目中(您也可以在我们的 GitHub 存储库上找到),Sass 文件结构如下: