老王说JavaDoc

开场白说点东西：

{

抓住客户的痛点、痒点、爽点，提出我们产品的核心价值。

产品定位

技术架构

以微服务为核心的前后端分离，业务积木装配式技术架构。传感器采集，物联网+互联网转换，大数据分布式、存储、计算、可视化加持。消息引擎、搜索引擎、工作流引擎全方位技术支持。

研发模式

Scrum敏捷研发，让每一次需求迭代（task），就像讲故事（story）一样简单。

交付流程

采用DevOps思想，实现有效的软件开发和运营，同时实现卓越的质量和用户体验。

}

javadoc简介 

       javadoc是Sun公司提供的一个技术，它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说，只要在编写程序时以一套特定的标签作注释，在程序编写完成后，通过Javadoc就可以同时形成程序的开发文档了。

写在类上面的javadoc

类名可设计author 作者信息 since初始版本信息 version当前版本信息和时间

/**
* 微信模板消息发送工具类
* 
* @author 作者
* @since [0.0.1]
* @version [0.0.1,2019年01月04日]
*/

工具类方法需要参数概述、入参、返回。换行用

/**
* 故障通报通知模板消息，内容如下

***{{first.DATA}}


***故障现象：{{performance.DATA}}

***故障时间：{{time.DATA}}

***{{remark.DATA}}
*
* 
* @param openid 所要发送对象的openid
* @param accessToken 当前微信公众号获取到的token，可用WechatUtil.getAccessToken(appid,appsecret)获取
* @param params 字符串map集合：

*********** appid、pagepath为小程序信息，如需小程序跳转可填写

*********** url若需链接跳转可填写(appid和url都填写则优先跳转小程序)

*********** firstData、performanceData、timeData、remarkData为必填（依次代表内容中字段信息）

*********** firstColor、performanceColor、timeColor、remarkColor如需自定义颜色可填写
* @return 返回发送结果，success为成功，其它为错误码
*/

java doc在eclipse中导出步骤

 

 

 

防止乱码输入：-encoding UTF-8 -charset UTF-8