首頁 / CompScience / Programming / Languages / java / Read How to Write Doc Comments for the Javadoc Tool

Read How to Write Doc Comments for the Javadoc Tool

昨天在[猜數字系列]DeepGreen v1.0 深綠 GUI版時,發現用jdk1.6.0_07編譯的時候會產生這樣的訊息:

Note: DeepGreen.java uses or overrides a deprecated API.
Note: Recompile with -Xlint:deprecation for details.

看來這個程式是舊了點了,所以我照著吩咐用javac -Xlint DeepGreen.java來看看是怎樣的情形:

DeepGreen.java:275: warning: [deprecation] show() in java.awt.Window has been de
precated
new DeepGreen().show();
^
DeepGreen.java:11: warning: [serial] serializable class DeepGreen has no definit
ion of serialVersionUID
public class DeepGreen extends javax.swing.JFrame {
^
2 warnings

有這兩個警告訊息,看來就清楚多了,就可以改了!

new DeepGreen().show();

show的方法過時要改setVisible(true)

第二個警告只要多加public   static   final   long   serialVersionUID   =   123456789L;

這樣一行就可以消除警告了!

不過進去看程式時看到@author  YoshiHuang這個註解,就Google,發現到sun的網站上有這樣一篇文章:How to Write Doc Comments
for the Javadoc Tool
,不過sun的文章有不得任意翻譯的限制,所以就再Google了一下,找到JavaTwo Friday學習札記有這兩篇類似的文章:

量身訂做自己的JavaDoc-上

量身訂做自己的JavaDoc-下

這對看如何在source寫註解很有幫助!

馬上成為工作達人的Fans

About ㄚ琪

工作達人Fun Taiwan的創辦者及總編,可以在這裡更認識他。

發表迴響

你的電子郵件位址並不會被公開。 Required fields are marked *

*

Scroll To Top

 好吃、好玩、旅遊、試吃、試用、邀稿、SEO

歡迎洽詢:flylinux@gmail.com

➨ 國外美食旅遊  日本東京自由行  美國猶他加州自由行  韓國釜山首爾慶州自由行 │ 泰國馬來西亞新加坡自由行  澳門廣東香港自由行日本九州奈良京阪自由行 │澳洲墨爾本坎培拉雪梨自由行 │中國北京自由行 

紅屋頂加級大阪難波飯店 (Red Roof Plus Osaka Namba) 日本大阪紅屋頂加級大阪難波飯店 (Red Roof Plus Osaka Namba)激推