- 综合排序
- 最热优先
- 最新优先
- 来自专栏前端lucio
VueJS文档生成
JSDoc语法 文档 jsdoc-vuejs插件新增了以下几个块标签 @vue-prop @vue-data @vue-computed 用法和@param一样。 6. 生成文档 在需要文档的地方，用块标签注释。
2.4K20编辑于 2023-04-22 - 来自专栏AI人工智能
AI 辅助文档生成：从接口注释到自动化 API 文档上线
本文将深入分析AI辅助文档生成的完整技术方案，包括代码注释智能解析、文档模板自动生成、多格式输出支持、版本控制集成等核心功能。 通过AI技术的加持，我们不仅能够实现文档的自动化生成，还能确保文档质量的持续提升。智能化的内容优化、多语言支持、交互式文档生成等高级特性，让文档不再是开发过程中的负担，而是成为提升团队协作效率的利器。 AI文档生成技术概览1.1 传统文档生成的痛点在传统的软件开发流程中，API文档的编写往往是最容易被忽视却又极其重要的环节。 技术在文档生成中的应用AI技术的引入为文档生成带来了革命性的变化。 核心技术架构设计2.1 系统架构概览AI文档生成系统采用微服务架构，确保各个组件的独立性和可扩展性：图2：系统架构图 - 展示AI文档生成系统的整体架构设计2.2 代码解析引擎代码解析引擎是整个系统的核心组件
1.1K10编辑于 2025-09-09 - 来自专栏全栈程序员必看
POSTMAN自动生成接口文档_swagger自动生成接口文档
介绍 drf-spectacular是为Django REST Framework生成合理灵活的OpenAPI 3.0模式。 它可以自动帮我们提取接口中的信息，从而形成接口文档，而且内容十分详细，再也不用为写接口文档而心烦了 这个库主要实现了3个目标 从DRF中提取更多的schema信息 提供灵活性，使schema在现实世界中可用 (不仅仅是示例) 生成一个与最流行的客户端生成器配合良好的schema 环境准备 Python >= 3.6 Django (2.2, 3.1, 3.2) Django REST Framework TITLE和DESCRIPTION和VERSION，如果想自定义更多的设置，请看文档 自定义接口内容信息 上面我们可以访问swagger接口文档，但是我们点开接口会发现没有任何内容信息 所以我们还需要在 summary：一个可选的短的总结描述 deprecated：将操作标记为已弃用 tags：覆盖默认标记列表 exclude：设置为True以从schema中排除操作 operation：手动覆盖自动发现将生成的内容
3.1K20编辑于 2022-09-19 基于生成式AI的智能文档处理架构解析
智能文档处理架构实现方案业务挑战某大型建材制造企业面临文档处理效率低下的问题，每月需要处理10万至30万份运输单据（POD）。原有光学字符识别系统准确率仅为30-40%，需要大量人工干预和维护。 主要技术需求包括：实现海量文档的自动化处理支持每月20万-30万文档的处理规模处理格式不统一的文档（如旋转页面、版式差异）将数据提取准确率提升至更高水平新增签名验证等智能功能技术架构解决方案采用事件驱动架构 ，核心流程包含以下环节：文档接收层使用邮件服务接收现场司机发送的运输单据基于对象存储事件通知实现规模化处理智能处理层文档解析阶段通过文档分析API调用布局和签名识别功能自动处理页面旋转问题并生成Markdown 格式文本数据提取阶段将Markdown文本输入生成式AI服务智能提取关键字段信息采用批处理模式优化成本（每页处理成本低于0.04美元）数据存储层处理结果存储至关系型数据库技术优势核心技术创新利用几何计算技术解决文档版式问题通过标记化输出控制优化处理成本采用微服务架构确保系统弹性性能表现处理规模从数千文档扩展至月均 ：供应商发票处理W9表格验证自动化文档审批工作流技术推荐建议进一步了解以下技术资源：云端智能文档处理方案基于提示流的文档自动化处理生成式AI在文档处理中的应用
26910编辑于 2025-09-27- 来自专栏后端1
接口文档生成工具 一键生成文档 ApiPost
一键生成文档 我们在“2分钟玩转APIPOST”一讲中，简单介绍了如何生成并分享接口文档： 点击分享文档 复制并打开文档地址就可以看到了完整的接口文档。 本节课主要是讲解一些需要注意的事项。 响应参数的描述填写 很多新手困惑为什么APIPOST分享的文档没有成功响应示例和错误响应示例，那是因为APIPOST不会把发送后的实时响应的数据作为响应示例。 Apipost官方链接： Apipost-基于协作，不止于API文档、调试、Mockconsole.apipost.cn/register?
1K30编辑于 2022-05-10 - 来自专栏复盘总结文章集合
MyEclipse生成javadoc文档
protected 前边带protected和public的都生成。 public 前边public的生成。（默认） ? 四。选好路径 ? 五。选择引用文件和项目以生成链接。 排除具有给定名称的所有文档文件子目录。 -group <name> <p1>:<p2>.. 不生成帮助链接 -nonavbar 不生成导航栏 -serialwarn 生成有关 @serial 标记的警告 的 @docRoot 替换为 <url> -charset <charset> 用于跨平台查看生成的文档的字符集。 指定源中每个制表符占据的空格数 -keywords 使程序包, 类和成员信息附带 HTML 元标记 -stylesheetfile <path> 用于更改生成文档的样式的文件
1.2K20发布于 2019-07-15 - 来自专栏HaC的技术专栏
MySQL生成word文档
把MySQL的表结构生成word文档说明的时候，可以借助以下方法： 下载驱动包 链接：https://pan.baidu.com/s/16tkYaO7l42XNxUPmQi5deQ 提取码：i6mq
5K10发布于 2020-12-30 - 来自专栏sofu456
doxygen文档生成工具
http://doxygen.nl/files/doxygen-1.8.17-setup.exe
1.7K10发布于 2020-04-08 - 来自专栏一朵灼灼华的博客
生成flask接口文档
背景 接触过几个针对flask自动生成接口文档的，但是感觉不太好用，然后发现了flask-docs，地址：https://github.com/kwkwc/flask-docs 但是感觉还是不太好用， 就进行了魔改 地址 https://gitee.com/heanny/flask-docs 添加的功能 可修改接口文档分类为中文 接口文档页面布局进行了优化美观 生成接口文档的方法进行了重构，并添加了部分兼容逻辑 添加了二级分类树 添加了html网页类型展示 修复部分问题 文档接口搜索已修复 测试页面接口及搜索已修复 form data可以使用，需要设置headers TODO 美化界面 增加的功能使用说明 中文类别 title="Sample App", version="1.0.0", description="A simple app API", ) doc.init_app(app) doc文档标题必须是第一行
2.7K10编辑于 2022-08-05 - 来自专栏FHADMIN
java生成word文档
} } } } } Map<String, Object> map=new HashMap<String, Object>(); //文档里面的列名为 ; 最后会有一个奇怪的bug，word文档里的${name}如果是手打上去就可以用，如果是复制上去就会被识别为三个字符串，也就是不能替换，当然也有解决方法，可以把全文复制到win自带的写字板（不需要调任何格式
2.4K20编辑于 2022-01-04 - 来自专栏大话swift
自动生成API文档
帮助文档查看 swagger
2.2K20发布于 2019-07-03 - 来自专栏同步文章
swagger生成接口文档
(https://swagger.io/) Spring Boot 可以集成Swagger，生成Swagger接口，Spring Boot是Java领域的神器，它是Spring项目下快速构建项目的框架。 2.Swagger常用注解 在Java类中添加Swagger的注解即可生成Swagger接口，常用Swagger注解如下： @Api：修饰整个类，描述Controller的作用 @ApiOperation pageAliase; //模版id @ApiModelProperty("模版id") private String templateId; } Swagger接口测试 Swagger接口生成工作原理 Swagger2Configuration类 2、在此类中指定了包路径com.xuecheng，找到在此包下及子包下标记有@RestController注解的controller类 3、根据controller类中的Swagger注解生成接口文档 启动项目，查看接口文档，请求：http://localhost:31001/swagger-ui.html 使用Swagger工具测试服务接口： 1）在cms服务接口中打断点 2）打开接口文档页面，输入请求参数
1.8K30编辑于 2022-10-25 内容创作如何结合AI？AI辅助创作（如代码生成文档优化）技巧
更关键的是，避免了“复制粘贴旧代码漏改变量名”这种低级bug——毕竟AI生成的代码是“新的”，但结构是标准的。2、AI辅助文档优化：从“写清楚”到“让别人愿意看” 技术文档的痛点是什么？ 后来我用AI智能媒体助理的“文档优化”功能，让它帮我调整：先提取核心问题：“缓存穿透是什么？怎么防？” 数据不会骗人：用AI优化后的技术文档，读者留存率提升41%，收藏量提升67%（来自我跟踪的10篇技术文的统计数据）。 后来用AI智能媒体助理的“多平台适配”功能，只需要输入核心内容：“AI辅助代码生成的3个技巧”，它会自动根据平台调性生成文案：微信公众号：深度长文，加“我踩过的坑”和“具体实现步骤”； 抖音 正规AI工具的训练数据都是合规的，而且生成的内容是基于通用知识。比如我用LangChain搭的工具，会过滤掉“复制特定项目代码”的请求，只生成通用模式的代码。
34810编辑于 2025-10-22- 来自专栏phodal
AI 增强技术文档写作体验：Shire 智能体语言生成示例
在这篇文章里，我们将分享其中的三个实践： 生成自定义风格注释 借助 pipeline 函数，自动生成文档文件 结合 RAG 技术，自动化分析文档 以及我们的一些思考。 几年前，为了提供技术框架文档的质量，我研究了市面上主流的文档生成工具、框架文档构建等，也总结了一些文档生成的最佳实践，诸如： 《文档同构：如何实现文档与代码的双向绑定？》 AI 增强技术文档写作体验 AI 增强的技术文档写作体验是一种创新的方法，将先进的人工智能技术与文档编写和管理深度融合。 以下是几个主要场景示例： 代码注释生成：通过分析代码内容，自动生成相应的文档注释，确保文档与代码同步更新，并减少手动维护的需求。 自动化内容生成：基于已有的代码注释，自动生成完整的文档内容，包括 API 说明、使用示例等，显著降低了手动编写和更新文档的工作量。
62910编辑于 2024-11-22 - 来自专栏Hugo博客
APIDoc自动生成接口文档
对于项目开发常见的前后端分离模式来说，中间在后端完成接口开发交付对接时，前端人员往往苦于没有接口文档会经常"跑去"骚扰后端人员，真是苦不堪言哪。 要是此时有个文档化的说明那就轻松多啦，现在后端流行的文档生成利器有Swagger，它虽然方便，但是也有弊端得写在的后台的代码中，而且启动整个后台项目才能访问。 所有相关的准备工作完成后，那么此时我们就需要来写关于接口描述的文档，这个具体要看你今后实际项目的开发语言，建议尽量选择相同的，在此我就以Java为示例，不需要具体的代码，只需填充代码注释部分的内容， * ] * } * * @apiUse Suc200 * * @apiUse Err400 * */ 生成接口文档 最后我们生成接口文档只需要一句简单的命令即可 ，如下： 1 apidoc -i apidoc/ -o apidoc/ i 工程所在的文件夹 o 接口文档输出文件夹 文档效果如下图所示： 常见问题 提示 error: Can not read:
50310编辑于 2024-11-20 OpenAPI 文档代码生成工具
前言 OpenAPI 文档是基于 OpenAPI 规范（OpenAPI Specification, OAS）撰写的，主要用于描述 RESTful API 的一种标准化方式。 它是 API 文档的格式化规范，帮助开发者清晰地定义和理解 API 的结构和行为。 而 OpenAPI 代码生成工具是一类基于 OpenAPI 规范自动生成代码的工具。 通过这些工具，开发者可以快速生成符合规范的客户端 SDK、服务器端代码或文档，而无需手动编写固定格式的代码。通过这些工具加可以重复代码的编写，让开发者更专注于业务逻辑的实现。 和 3.0）的情况下自动生成 API 客户端库（SDK 生成）、服务器存根、文档和配置。 小结 OpenAPI 代码生成工具是现代 API 开发不可或缺的加速器。它们通过自动化生成代码、文档以及样板，让开发者专注于业务逻辑的创新。
1.6K107编辑于 2025-01-04- 来自专栏iOSDevLog
Xcode 自动生成文档
jazzy.png Xcode 文档注释快捷键： ⌥ + ⌘ + swift-documentation: https://nshipster.com/swift-documentation/ jazzy : Swift 和 Objective-C 的灵活文档 ---- https://github.com/realm/jazzy 安装 $ [sudo] gem install jazzy Command Line Tools $ xcode-select --install 确保选择正确的 Command Line Tools Command Line Tools.png 使用 $ jazzy 生成
1.5K20发布于 2019-04-17 - 来自专栏逸鹏说道
【开源】文档生成工具 DocFX
OpenLiveWriter/issues/203 详细：http://dotnet.github.io/docfx/tutorial/docfx_getting_started.html 微软最近开源了全新的文档生成工具 DocFX，目前支持C＃和VB，类似JSDoc或Sphinx，可以从源代码中提取注释生成文档之外，而且还有语法支 持你加入其他的文件链接到API添加额外的说明，DocFX会扫描你的源代码和附加的文件为你生成一个完整的
1.4K40发布于 2018-04-11 - 来自专栏C/C++基础
Gin 生成 Swagger 接口文档
生成的 docs 包 注册 Gin router 5.FAQ 参考文献 1.背景 后台服务通过接口（如 RESTful API）对外提供服务时，需要有明确的接口文档。 书写接口文档，我们可以手动书写，也可以采用工具自动生成。手动书写的问题在于接口协议变更后需要维护接口文档，效率低下。采用工具生成，不同的工具生成的接口文档风格不一，增加阅读者的理解成本。 因此，我们可以采用业界常用的 Swagger 为 RESTful API 生成可交互的接口文档。 本文以 Gin 框架为例，描述 Gin 中如何为接口生成 Swagger 文档。 可通过编写 yaml 和 json 来实现接口的文档化，并且可以进行测试等工作。 通过 Swagger 可以方便地生成接口文档，方便前端进行查看和测试。 使用 Swagger 就是把接口相关信息存储在它定义的描述文件里面（yaml 或 json 格式），再通过维护这个描述文件可以去更新接口文档，以及生成各端代码。
2.9K30编辑于 2023-02-23 - 来自专栏全栈开发那些事
用IDEA生成javadoc文档
文章目录 一、前言 二、IDEA生成API的步骤 1、Tools->Genearte javaDoc 2、设置 1、参数解释: 2、生成文档 3、文档结构如下： 一、前言 javadoc是Sun javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。 二、IDEA生成API的步骤 1、Tools->Genearte javaDoc 2、设置 1、参数解释: locale:zh_CN：表示生成中文文档 encoding UTF-8:源代码使用UTF -8编码 charset UTF-8:表示生成的文本字符集使用UTF-8编码 windowtitle “title”:表示用浏览器打开时的窗口标题 2、生成文档 3、文档结构如下： 打开index.html 即可查看生成的API
2K21编辑于 2023-02-25
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号