使用结构化html注释可自动生成文档，通过@component、@desc、@param等标记定义内容，结合脚本提取并转换为markdown或HTML文档，集成到构建流程后实现代码与文档同步更新，提升团队协作效率。
HTML注释不仅可以帮助开发者理解代码结构，还能作为自动生成文档的数据源。通过在HTML中添加结构化的注释，工具可以提取这些信息并生成API文档、组件说明或项目指南。
使用结构化注释标记关键内容
为了让注释能被文档生成工具识别，需要遵循一定的格式规范。常见的做法是使用特定前缀或标签来标识文档块。
- 用
<!-- @component 名称 -->标记一个ui组件的开始 - 用
<!-- @desc 描述文本 -->提供功能说明 - 用
<!-- @param 参数名 类型 说明 -->描述输入参数 - 以
<!-- @end -->结束一个文档块
例如：
<!-- @component Button Primary @desc 主要操作按钮，用于表单提交等场景 @param size string small|medium|large 按钮尺寸 @param disabled boolean false 是否禁用 @end --> <button class="btn primary">提交</button>配合脚本提取注释生成文档
可以编写node.js脚本或使用正则表达式扫描HTML文件，提取带有特定标记的注释内容，并将其转换为Markdown或HTML格式的文档页面。
立即学习“前端免费学习笔记（深入）”；
- 读取所有
.html文件内容 - 使用正则匹配
/<!-- @(.*?) -->/gs捕获文档块 - 解析每行指令并构建jsON结构
- 将数据传入模板引擎（如Handlebars或Pug）输出文档页
这样每次代码更新后运行脚本，就能得到最新的静态文档站点。
集成到构建流程提升效率
将注释提取过程加入项目的CI/CD或本地构建流程中，确保文档与代码同步更新。
团队成员无需手动维护文档，只需在写HTML时补充注释即可。
基本上就这些。合理利用HTML注释做文档生成，既不影响页面渲染，又能保持开发与文档的一致性，是一种轻量高效的实践方式。