老王說JavaDoc

開場白說點東西:java

{小程序

抓住客戶的痛點、癢點、爽點,提出咱們產品的核心價值。後端

產品定位微信

技術架構架構

以微服務爲核心的先後端分離,業務積木裝配式技術架構。傳感器採集,物聯網+互聯網轉換,大數據分佈式、存儲、計算、可視化加持。消息引擎、搜索引擎、工做流引擎全方位技術支持。app

研發模式前後端分離

Scrum敏捷研發,讓每一次需求迭代(task),就像講故事(story)同樣簡單。eclipse

交付流程分佈式

採用DevOps思想,實現有效的軟件開發和運營,同時實現卓越的質量和用戶體驗。微服務

}

javadoc簡介 

       javadoc是Sun公司提供的一個技術,它從程序源代碼中抽取類、方法、成員等註釋造成一個和源代碼配套的API幫助文檔。也就是說,只要在編寫程序時以一套特定的標籤做註釋,在程序編寫完成後,經過Javadoc就能夠同時造成程序的開發文檔了。

寫在類上面的javadoc

類名可設計author 做者信息 since初始版本信息 version當前版本信息和時間

/**
* 微信模板消息發送工具類

* @author 做者
* @since [0.0.1]
* @version [0.0.1,2019年01月04日]
*/

工具類方法須要參數概述、入參、返回。換行用<br>

/**
* 故障通報通知模板消息,內容以下<br>
***{{first.DATA}}<br><br>
***故障現象:{{performance.DATA}}<br>
***故障時間:{{time.DATA}}<br>
***{{remark.DATA}}
*

* @param openid 所要發送對象的openid
* @param accessToken 當前微信公衆號獲取到的token,可用WechatUtil.getAccessToken(appid,appsecret)獲取
* @param params 字符串map集合:<br>
*********** appid、pagepath爲小程序信息,如需小程序跳轉可填寫<br>
*********** url若需連接跳轉可填寫(appid和url都填寫則優先跳轉小程序)<br>
*********** firstData、performanceData、timeData、remarkData爲必填(依次表明內容中字段信息)<br>
*********** firstColor、performanceColor、timeColor、remarkColor如需自定義顏色可填寫
* @return 返回發送結果,success爲成功,其它爲錯誤碼
*/


java doc在eclipse中導出步驟

 

 

 

防止亂碼輸入:-encoding UTF-8 -charset UTF-8 

相關文章
相關標籤/搜索