关于文档一二事

之前我有提过文档的事,标题是<文档!文档!文档!重要的事情说三遍!>,其中提到的文档工具是使用wiki来管理文档,当然也能配合jira来分发任务,以及管理bug,查看每个任务的工作流状态等等 今天来讲讲另外一个文档工具,swagger+spring,这个插件比较好用,非常适合那种敏捷开发的小团队,不像wiki那么繁琐,更没有word或者excel那么难以管理,使用这个工具,你只需要在代码中配置好相应的注解,在spring容器加载的时候就自动扫描进去了,使用非常方便,那么先来简单看看吧 ? 首先

这里记录一些play!框架的文档未提及,但是可以做的一些事playframe版本1.1 1.application.conf文件可以拆分可以把application.conf文件拆成多个,需要在application.conf文件中加上@include.xxx=zzz.confxxx任意命名,xxx.conf放在conf目录下(与application.conf同一目录)如:application.conf@include.site=mysite.conf@include.hibernate=h

以前在XX之家的时候,上面派给技术部一个重要的工作,就是写技术方面的专利文档,还要求每月每个技术组必须至少写一份. 我们组(二手车技术组)的“重任”就自然落到我头上了(毕竟以前当过部门经理,写文档和报表比较拿手). 当时还规定了奖励规则: 1. 凡是通过了公司级别的审核后,奖励写专利的人2000元 RMB 2. 凡是通过了专利局的审核,成功申请了专利的,再次奖励写专利的人2000元 RMB 刚开始,依照此规定,俺在二手车技术BQQ群里大力做宣传,鼓动大家写. 可效果非常差,大家貌似都不愿意写,每

大多数开源开发人员喜欢思考他们构建软件的质量,但其文档的质量常常被遗忘.没有人谈论一个项目的文档是多么出色,但其实文档对一个项目的成功却有直接的影响.没有一个良好的文档可能用户根本不会使用你的项目,亦或者压根不会喜欢. 然而大多数开源项目的文档都是令人极其失望的,主要从以下的几个方面来体现. 1. 缺乏一个好的自述或介绍 自述是潜在用户对你项目的第一印象.如果项目在 GitHub 上,自述自动的显示在该项目的主页上.如果你稍微不留神将自述弄错了,这些潜在的用户有可能再也不会回来了.所以你的项目必

简介 什么是 MyBatis ? MyBatis 是支持定制化 SQL.存储过程以及高级映射的优秀的持久层框架.MyBatis 避免了几乎所有的 JDBC 代码和手动设置参数以及获取结果集.MyBatis 可以对配置和原生Map使用简单的 XML 或注解,将接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java对象)映射成数据库中的记录. 入门 安装 要使用 MyBatis, 只需将 mybatis-x.x.x.jar 文件置于 classpath 中即

众所周知,现在解析XML的方法越来越多,但主流的方法也就四种,即:DOM.SAX.JDOM和DOM4J 一.介绍及优缺点分析 1. DOM(Document Object Model) DOM是用与平台和语言无关的方式表示XML文档的官方W3C标准.DOM是以层次结构组织的节点或信息片断的集合.这个层次结构允许开发人员在树中寻找特定信息.分析该结构通常需要加载整个文档和构造层次结构,然后才能做任何工作.由于它是基于信息层次的,因而DOM被认为是基于树或基于对象的. [优点]      ①允许应用

1.   入门 1.1.  基本语法 1.1.1.   定义包 包说明应该在源文件的顶部: 1 package my.demo 2 import java.util.* 3 // … 并不要求包与目录匹配:源文件可以在文件系统中的任意地方. 查看:包(2.2) 1.1.2.   定义函数 函数带有Int类型参数,并返回Int类型值: 1 fun sum(a: Int, b: Int): Int { 2 return a+b 3 } 函数体可以是表达式,并可从中推断出返回值类型: 1 fun su

[写在前面]尝试做完一件工作之外自我觉得有意义的一件事,那就从翻译Autofac的帮助文档吧. 入门指南 将Autofac集成你的应用程序的步骤通常很简单,一般是: 时刻以IOC(控制反转)的思想来规划你的应用程序 在你的Porject中添加Autofac引用 按照如下步骤设计应用程序的启动环节 创建一个ContainerBuilder 向ContainerBuilder注册组件 通过ContainerBuilder的Build()方法获得Container(后续需用到) 在应用程序运行环节时,

原文:http://www.jianshu.com/p/8033ef83a8ed 由于Spring Boot能够快速开发.便捷部署等特性,相信有很大一部分Spring Boot的用户会用来构建RESTful API.而我们构建RESTful API的目的通常都是由于多终端的原因,这些终端会共用很多底层业务逻辑,因此我们会抽象出这样一层来同时服务于多个移动端或者Web前端. 这样一来,我们的RESTful API就有可能要面对多个开发人员或多个开发团队:IOS开发.Android开发或是Web开发