DotNet Core Web API给开发者提供了一个很好的框架来开发Restful的API。那么这些API接口该如何管理起来呢？Swagger是一个很好的选择，Swagger不需要开发者额外去维护接口文档，只要开发者的接口遵循Restful的规范，Swagger就会根据API接口生成文档。 对于 ...
1.安装 在ruby 环境下，运行命令 ：gem install jsduck 2.使用 生成文档命令：jsduck [sourcePATH] --output [targetPATH] 3.语法 查看官方文档 https://github.com/senchalabs/jsduck/wiki 4. ...
分类：
Web程序 时间：
2017-08-30 12:01:49
阅读次数：
163
用脚本语言发送邮件是系统管理员必备技能对系统定期检查或者当服务器受到攻击时生成文档和报表。发布这些文档最快速有效的方法就是发送邮件。python中email模块使得处理邮件变得比较简单发送邮件主要用到了smtplib和email两个模块，这里首先就两个模块进行一下简单的介绍：本段..
分类：
其他好文 时间：
2017-08-27 22:31:55
阅读次数：
401
一、定义：注解（也被称为元数据）为我们在代码中添加信息提供了一种形式化的方法，使我们可以在稍后某个时刻非常方便地使用这些数据。 二、作用：①编写文档 ：通过代码里标识的元数据生成文档【生成文档doc文档 @param @return @see @exception @version @author ...
分类：
编程语言 时间：
2017-08-23 19:59:03
阅读次数：
157
很简单,大功告成,界面太丑,可以自定义界面.看手册. ...
分类：
Web程序 时间：
2017-08-20 21:10:15
阅读次数：
202
程序员都很希望别人能写技术文档，自己却很不愿意写文档。因为接口数量繁多,并且充满业务细节,写文档需要花大量的时间去处理格式排版,代码修改后还需要同步修改文档,经常因为项目时间紧等原因导致文档滞后于代码，接口调用方的抱怨声不绝于耳。而程序员是最擅长"偷懒"的职业了,自然会有多种多样的自动生成文档的插件 ...
分类：
编程语言 时间：
2017-08-06 18:13:21
阅读次数：
193
首先声明下，apidoc是基于注释来生成文档的，它不基于任何框架，而且支持大多数编程语言，为了springboot系列的完整性，所以标了个题。 一、apidoc简介 apidoc通过在你代码的注释来生成api文档的。它对代码没有侵入性，只需要你写好相关的注释即可，并且它仅通过写简单的配置就可以生成高 ...
分类：
编程语言 时间：
2017-07-31 15:45:54
阅读次数：
220
当今时代，前端代码变的庞大复杂，代码维护、打包极其困难。所以前端的自动化构建工具显得尤为重要。我们要讲的就是grunt。grunt是一个基于node.js的自动化构建、测试、生成文档的项目管理工具。 一.安装grunt 1.安装grunt之前首先得安装node：从官网上下载，安装即可，在命令行中输入 ...
分类：
其他好文 时间：
2017-07-30 11:26:16
阅读次数：
190
对于开发人员来说，构建一个消费应用程序时去了解各种各样的 API 是一个巨大的挑战。在你的 Web API 项目中使用 Swagger 的 .NET Core 封装 Swashbuckle 可以帮助你创建良好的文档和帮助页面。 Swashbuckle 可以通过修改 Startup.cs 作为一组 N ...
一.注解的基本 1.注解的通俗理解 注解（Annotation） 为我们在代码中添加信息提供了一种形式化的方法，是我们可以在稍后 某个时刻方便地使用这些数据（通过解析注解来使用这些数据）。 2.注解的作用 生成文档 跟踪代码依赖性，实现替代配置文件功能,减少配置。如Spring中的一些注解 在编译时 ...
分类：
编程语言 时间：
2017-07-25 14:26:19
阅读次数：
257
