UCloud云社区

phoenixsky 发布于2019-08-16 13:34 / 3421人阅读

前言

程序员一直以来都有一个烦恼，只想写代码，不想写文档。代码就表达了我的思想和灵魂。

Python提出了一个方案，叫docstring，来试图解决这个问题。即编写代码，同时也能写出文档，保持代码和文档的一致。docstring说白了就是一堆代码中的注释。Python的docstring可以通过help函数直接输出一份有格式的文档，本工具的思想与此类似。

代码即文档

Apiggs是一个非侵入的RestDoc文档生成工具。工具通过分析代码和注释，获取文档信息，生成RestDoc文档。

引入插件

apiggs-gradle-plugin

apiggs-maven-plugin

有这样一段代码

/**
 * 欢迎使用Apiggs
 * @index 1
 */
@RestController
public class GreetingController {

    private static final String template = "Hello, %s!";
    private final AtomicLong counter = new AtomicLong();

    /**
     * 示例接口
     * @param name 名称
     * @return
     */
    @RequestMapping("/greeting")
    public Greeting greeting(@RequestParam(value="name", defaultValue="apiggs") String name) {
        return new Greeting(counter.incrementAndGet(),
                String.format(template, name));
    }
}

运行插件

gradle 运行 task:

Tasks/documentation/apiggs

maven 运行

compile

生成文档

在编译目录下生成apiggs文件夹，并生成三个文件：

.json文件，可直接导入postman

.adoc文件，Asciidoc源文件

.html文件，源文件渲染结果，效果如下图

想了解更多，请查看Wiki

云服务器 GPU云服务器政务快车道尹世明总经理

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/71952.html

vue中如何实现的自定义按钮

摘要：在实际开发项目中，有时我们会用到自定义按钮因为一个项目中，众多的页面，为了统一风格，我们会重复用到很多相同或相似的按钮，这时候，自定义按钮组件就派上了大用场，我们把定义好的按钮组件导出，在全局引用，就可以在其他组件随意使用啦，这样可以大幅度在实际开发项目中，有时我们会用到自定义按钮；因为一个项目中，众多的页面，为了统一风格，我们会重复用到很多相同或相似的按钮，这时候，自定义按钮组件就...

biaoxiaoduan 2019-08-23 16:29 评论0 收藏0
JavaScript代码整洁之道

摘要：代码整洁之道整洁的代码不仅仅是让人看起来舒服，更重要的是遵循一些规范能够让你的代码更容易维护，同时降低几率。另外这不是强制的代码规范，就像原文中说的，。里式替换原则父类和子类应该可以被交换使用而不会出错。注释好的代码是自解释的。 JavaScript代码整洁之道整洁的代码不仅仅是让人看起来舒服，更重要的是遵循一些规范能够让你的代码更容易维护，同时降低bug几率。原文clean-c...

liaorio 2019-08-23 16:29 评论0 收藏0
前端经典面试题总结

摘要：接着我之前写的一篇有关前端面试题的总结，分享几道比较经典的题目第一题考点作用域，运算符栗子都会进行运算，但是最后之后输出最后一个也就是那么其实就是而且是个匿名函数，也就是属于，就输出第二和第三个都是类似的，而且作用域是都是输出最后一个其实就接着我之前写的一篇有关前端面试题的总结，分享几道比较经典的题目：第一题： showImg(https://segmentfault.com/im...

BlackMass 2019-08-23 16:29 评论0 收藏0
私有云那家好-六大私有云厂商详细对比！

对比内容UCloudStackZStackVMwareQingCloud腾讯TStack华为云Stack优势总结•基于公有云自主可控•公有云架构私有化部署•轻量化/轻运维/易用性好•政府行业可复制案例轻量化 IaaS 虚拟化平台•轻量化、产品成熟度高•业内好评度高•功能丰富、交付部署快•中小企业案例多全套虚拟产品及云平台产品•完整生态链、技术成熟•比较全面且健全的渠道•产品成熟度被市场认可，市场占...

ernest.wang 2022-07-05 17:45 评论0 收藏0
cross-env使用记录

摘要：能跨平台地设置及使用环境变量让这一切变得简单，不同平台使用唯一指令，无需担心跨平台问题安装方式改写使用了环境变量的常见如在脚本多是里这么配置运行，这样便设置成功，无需担心跨平台问题关于跨平台兼容，有几点注意 cross-env能跨平台地设置及使用环境变量, cross-env让这一切变得简单，不同平台使用唯一指令，无需担心跨平台问题 1、npm安装方式 npm i --save-de...

Michael_Ding 2019-08-23 16:29 评论0 收藏0
webpack打包插件

摘要：引入的模块引入的使用将打包打包的拆分将一部分抽离出来物理地址拼接优化打包速度压缩代码，这里使用的是，同样在的里面添加 const path = require(path); //引入node的path模块const webpack = require(webpack); //引入的webpack,使用lodashconst HtmlWebpackPlugin = require(ht...

ChanceWong 2019-08-23 16:29 评论0 收藏0