知识卡片

普通读书笔记卡 · 2894

文档贴近代码

理解等级:未标注

样式表已演化成有变量、函数和逻辑的系统,文档也要跟上。Hologram 让开发者在写代码时直接在 Sass 或 JavaScript 文件中写文档注释,再自动收集,生成带渲染示例和代码示例的网站。样式文档与设计系统因此合为一体,不用维护两套代码库,哪段代码注释不足也一眼可见。发散:文档离代码越远,越容易从知识变成历史。

这张卡片看不懂?

已有反馈 · 0 / 10 条

    还没有人提交反馈。

    原书出处

    参考来源

    - 位置:《前端架构设计》第15章《样式文档》(源文件:_epub-src/OEBPS/text00000.html) - 结论依据:原文说明 Hologram 允许在编写代码时直接在 Sass 或 JavaScript 文件中注释,自动收集注释生成含渲染示例和代码示例的网站,不再维护两个代码库,注释不足也容易被发现。 - 原始内容:它允许我们在实际编写代码时,直接在 Sass 或者 JavaScript 文件中给系统进行注释。……这意味着我们不是在维护两个单独的代码库,而是将样式文档和实际的设计系统结合在一起。