首先声明下，apidoc是基于注释来生成文档的，它不基于任何框架，而且支持大多数编程语言，为了springboot系列的完整性，所以标了个题。 一、apidoc简介 apidoc通过在你代码的注释来生
简单的变量声明之类的内容可以进行简单注释，但是函数就不能这样做了，要知道注释的作用是一种为了让代码更易读、易维护、易理解，起到提示的作用的，上面的两个注释都是正确的，但是它起到的作用太低了，在正式工作中我们往往会协同开发，这种注释是万万不可的。
摘要: 原文可阅读 http://www.iocoder.cn/Fight/web-api-doc 「老梁」欢迎转载，保留摘要，谢谢！
你可能用过jsdoc，用代码里面的注释生成文档。但是苦于jsdoc生成的文档网页太不好看，目录结构不好调整。
在一个风和日丽的早晨，我正悠闲地喝着Coffe，突然领导向我走来，我赶紧熟练地切出VSCode，淡定自若地问：领导，什么事？领导拍了拍我的肩膀：你上次封装的方法同事跟我反馈使用起来很不错啊，你不如做成JS插件给大家用吧。我放下了手中的马克杯，甩了一下眼前仅剩的几根刘海：没问题啊，小Case！随即开始摸鱼....
需要备上下面三样东西 JSDocTookit http://code.google.com/p/jsdoc-toolkit/
我们的打包配置有一个基类文件，并根据不同的打包需求，有不同子类文件——完整组件库打包、单个组件打包、打包示例工程。
TypeScript 我们知道，是用来给 JS 加上类型的，可以实现类型提示和编译时的类型检查。
docsify是一个基于JavaScript 的文档生成器，它可以帮助你快速构建漂亮、响应式的文档网站。
在我们使用Swagger的时候，经常会需要用到它的注解，比如@Api、@ApiOperation这些，Swagger通过它们来生成API文档。比如下面的代码：
Doxygen是一款非常方便的文档生成工具，以类似JavaDoc风格描述的文档系统，完全支持C、C++、Java等语言，据说也支持python等。用他不仅可以根据注释生成文档，而且还能利用graphviz工具生成类图以及类中的函数调用关系，并且支持html、latex、rtf等格式的输出。
敏捷开发最强大易用的 HTTP 接口工具，机器学习零代码测试、生成代码与静态检查、生成文档与光标悬浮注释。集 文档、测试、Mock、调试、管理 于一体的一站式体验，还有一键 格式化、注释/取消注释 等高效易用的快捷键。
Web Components 实际上和现在 React/Vue 等前端框架的组件概念十分相似，或者倒不如说 Vue 的 SFC（单文件组件）其实正是借鉴自 Web Components 的概念。 它本身 Shadow DOM 的方案做了 CSS 隔离，很好地解决了 CSS 命名污染等问题，但 Web Components 除了规范推进缓慢，也还有很多开发（效率、生态、兼容等）上的不足。
包含.rst文件的根目录称之为源文件目录，目录中还包含sphinx的配置文件conf.py。
本文档主要用来指导和建议工程师如何写好软件代码的注释，方便使用Doxygen生成文档
更新了AS 3.1.2之后，发现新建Kotlin类，类注释依然木有，没办法只有自己动手了。
JavaScript已经巩固了其作为近年来最常用的脚本语言之一的地位。它以在Web平台上编写脚本的简易性而闻名。随着语言的发展，它从最初只是一个利用Java成功的“玩具”语言，发展成为一个用于构建不仅仅是小型脚本的完整语言。
Java 注释是一种用于在代码中添加说明和解释的特殊文本。它们不会被编译器处理，因此对程序的运行没有任何影响。Java 注释主要有三种类型：单行注释、多行注释和文档注释。
注释 是使用文字描述程序 , 是 给开发和维护程序的人员看的 , 编译器在编译时会将注释删除 ;
以上这篇Android Studio 实现文档注释的快捷键就是小编分享给大家的全部内容了，希望能给大家一个参考。
SwaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用（官方demo）。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。
参考资料： https://www.cnblogs.com/zhn0823/p/6542335.html https://blog.csdn.net/shenxianhui1995/article/details/81604818 https://github.com/varHarrie/varharrie.github.io/issues/10
生成文档的模块叫做 pydoc，当我们安装完成Python以后，它就会被自动添加进环境变量里面。
安装后，按快捷键Ctrl+Shift+P，输入 configure language
相信不少的小伙伴都会在日常工作中写API文档，确实这个文档很有必要去写，便于项目的维护，在我们提桶的时候，接盘侠可以轻松地接管我们的项目。说起API文档，我们脑海中想到的就是肯定是Swagger，他以前确实统治了江湖很久，因为他的确很方便，也很智能，但是吧，你写多了总感觉哪里不对劲，是的，他的代码侵入性太强，而且要写大量重复的注释，那我最近在写的一个项目来说，简直是程序员的梦魇。
smart-doc是一款同时支持JAVA REST API和Apache Dubbo RPC接口文档生成的工具，smart-doc在业内率先提出基于JAVA泛型定义推导的理念， 完全基于接口源码来分析生成接口文档，不采用任何注解侵入到业务代码中。你只需要按照java-doc标准编写注释， smart-doc就能帮你生成一个简易明了的Markdown、HTML5、Postman Collection2.0+、OpenAPI 3.0+的文档。
本人长期以来一直从事于金融应用软件的研发以及项目实施工作，经常做数据库建模（数据表设计）。有一款称心如意的数据库建模工具，自然能够事半功倍，PowerDesigner的pdm模型为我的工作提供了很大的便利性。但电脑换了Mac系统之后，就只能在虚拟机Windows上使用PD，机器越来越吃不消了。PD是一款商业化优秀的建模工具。其设计初衷就是用作数据库建模，所以他必然是一款非常优秀的数据库建模工具。
在 Rust 中，文档注释（doc comments）是一种特殊的注释格式，用于为代码提供文档和说明。文档注释可以包含在函数、结构体、枚举、模块等代码元素之前，以提供关于代码功能、使用方法和示例的详细说明。本篇博客将详细介绍 Rust 中的文档注释的使用方法、格式和最佳实践。
" 每次开发完新项目或者新接口功能等，第一件事就是提供接口文档。说到接口文档，当然是用 Markdown 了。各种复制粘贴字段，必填非必填，字段备注，请求返回示例等等。简直是浪费时间哇。所以想到了开发一款插件来解决重复复制文档的问题。下面来看我介绍介绍这款插件。 "
Doxygen是一个代码文档生成工具。它从代码文件中提取注释并可生成多种文档形式。如：网页文档HTML，RTF (MS-Word)，PDF等等。同时也可生成函数之间的调用和文件的依赖关系图表。
比如一个接口，不同时间往后端传的字段time的值是实时变化的，那么我们只管时候，就要将time的值设置为动态的
现在越来越流行前后端分离，使得前后端解耦。前后端的联系来源于数据接口，所以后端每次实现数据接口后都需要给前端写API接口文档，但是每次手写API文档很麻烦而且降低工作效率，其实有很多框架可以实现API文档自动生成，最著名的可能是swagger。但是swagger对于windows版本NodeJS开发者有点不友好，所以我尝试了一下最后放弃了，最后选择了使用apidoc来自动化生成API文档。
在上一篇文章——《细说API - 重新认识RESTful》中介绍了如何理解和设计RESTful风格的API，现在我们来聊聊如何有效的呈现API文档，以及前后端协作的方式。
上一篇文章中介绍了使用Swagger生成接口文档，非常方便，功能也十分强大。如果非要说Swaager有什么缺点，想必就是注解写起来比较麻烦。如果我说有一款不用写注解，就可以生成文档的工具，你心动了吗？他就是我们今天的主角——JApiDocs。
在软件开发中，代码的可读性和可维护性是至关重要的因素。良好的注释可以使代码更易于理解、修改和维护，同时有助于团队合作。Go语言作为一门强调简洁性的编程语言，同样也非常重视注释的作用。本篇博客将深入探讨Go语言中的注释，包括注释的类型、最佳实践以及如何充分利用注释提升代码质量。
java也可以生成文档, 就像一个手册一样, 可以用来查看方法, 接口, 下面我们给go项目生成文档
swagger想必大家都用过吧，非常方便，功能也十分强大。如果要说swaager有什么缺点，想必就是注解写起来比较麻烦。如果我说有一款不用写注解，就可以生成文档的工具，你心动了吗？他就是我们今天的主角——JApiDocs。
swagger想必大家都用过吧，非常方便，功能也十分强大。如果要说swagger有什么缺点，想必就是注解写起来比较麻烦。如果我说有一款不用写注解，就可以生成文档的工具，你心动了吗？他就是我们今天的主角——JApiDocs。
Java的三种注释： （1）单行注释：// 注释内容 （2）多行注释：/… 注释内容…./ （3）文档注释：/*.. 注释内容…./ （这种注释可以用来自动地生成文档。在JDK中有个javadoc的工具，可以由源文件生成一个HTML文档。使用这种方式注释源文件的内容，显得很专业，并且可以随着源文件的保存而保存起来。也就是说，当修改源文件时，也可能对这个源代码的需求等一些注释性的文字进行修改，那么，这时候可以将源代码和文档一同保存，而不用再另外创建一个文档。）
上一篇文章中已经介绍过swagger了，非常方便，功能也十分强大。如果非要说Swaager有什么缺点，想必就是注解写起来比较麻烦。如果我说有一款不用写注解，就可以生成文档的工具，你心动了吗？他就是我们今天的主角——JApiDocs。
1. 安装JSDoc 3 http://usejsdoc.org/index.html npm install -g jsdoc 2. 安装jsdoc-vuejs插件 https://github.com/Kocal/jsdoc-vuejs npm install --save-dev jsdoc-vuejs 3. 配置JSDoc 新建conf.json文件 { "plugins": [ "node_modules/jsdoc-vuejs" ], "source": { "inc
javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。 javadoc命令是用来生成自己API文档的，使用方式：使用命令行在目标文件所在目录输入javadoc +文件名.java。
在使用 phpDocumentor 等工具生成文档时, 会识别相关注释, 而且IDE也会识别, 在编码的过程中会给出提示.
前几天粉丝群有小伙伴问，有啥好用的API文档工具推荐，无意间发现了一款工具，这里马不停蹄的来给大家分享一下。
关于大多数程序员不爱写文档问题， 我觉得可以从两个方面去拆解：主观原因、客观原因。
微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX，目前支持C＃和VB，类似JSDoc或Sphinx，可以从源代码中提取注释生成文档之外，而且还有语法支持你加入其他的文件链接到API添加额外的说明，DocFX会扫描你的源代码和附加的文件为你生成一个完整的HTML模版网站，你可以自己通过模版定制，目前已经内嵌了几个模版，包括静态的HTML页面和AngularJS页面。你还可以自己定制模版，具体参考 how to create custom template。 源代码： http
在做项目的时候，如果项目是前后分离的，后端一定要和前端或者是移动端对接接口，那么问题来了，接口是不是要自己写给他们看，一般的会采用Excel或者Word来写，高级一点的就采用API管理平台手工录入，一个项目有上千上万个接口，天啊，这是多么大的工作量，在接口维护的时候更加痛苦，为了解决这样的事我们可以借助 japi 这个项目来完成RESTFul文档的自动生成，完全基于注释生成，更多详细配置可查看https://github.com/dounine/japi。
1.开发背景 最近一直在写dubbo接口，以前总是用word文档写接口描述然后发给别人。现在太多了，而且跟别人对接联调的人家急着用，根本没时间去写word文档。那就想想怎么用doc文档注释自动生成接口文档了。本来以前对这一块有点印象，但是并不熟悉，加上没有很强烈的要去使用的意图，所以一直没有弄。今天要感谢公司的大神，大家都叫他欧神，神一样的男人。让我用文档注释。然后就知道怎么弄了，以下是生成的流程。 2.生成方法 先说生成的方法吧，免得一开始将注释规范可能读者觉得比较繁琐，而且注释规范基本上大家都有一套自己
领取专属 10元无门槛券
手把手带您无忧上云
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频
