java 方法注解

幾乎沒有什么@Deprecated沒有適當(dāng)?shù)奈臋n看到@Deprecated方法更令人生氣的了。 我感到失落。 我應(yīng)該仍然使用該方法嗎？ 可能這不是開發(fā)人員的意圖，這就是為什么他/她添加了棄用注釋。 我應(yīng)該使用其他東西嗎？ 所以…。

使用@Deprecated的規(guī)則是什么？

規(guī)則1：Javadoc怎么做

每當(dāng)您不贊成使用方法時(shí)，請創(chuàng)建一個(gè)JavaDoc，該JavaDoc告訴程序員如何不再使用此方法。 不僅要說“不贊成使用此方法，請不要使用它”。 這正是棄用注釋和JavaDoc @deprecated單詞所說的。 沒有必要用英語重復(fù)它。 目標(biāo)讀者是Java程序員，應(yīng)該知道過時(shí)意味著什么。

為新方法命名，以替代舊方法。 （使用@link ！）這可能足夠，也可能不夠。 新方法將包含一些說明如何使用它的文檔。 不要在JavaDoc中重復(fù)（文本或含義）。 只是不要重復(fù)自己，文檔也應(yīng)該干燥。 另一方面，您可能要描述如何用新的電話替換舊的電話。 您可能會(huì)提示重構(gòu)。

規(guī)則2：不要Javadoc如何

刪除舊的JavaDoc文檔。 有人可能會(huì)爭辯說，保留舊代碼的用戶可能仍然需要它。 事實(shí)是，他們在庫的舊版本中使用該方法的舊版本。 舊版本的文檔仍然存在，它們被冷凍刻在石頭上（或者刻在存儲(chǔ)庫中的發(fā)行版中）。 棄用該方法的實(shí)際版本不應(yīng)包含過時(shí)的文檔。 這將鼓勵(lì)程序員繼續(xù)使用該方法。 有一種使用不推薦使用的方法的方式：不使用它。 如上規(guī)則1中所述，JavaDoc應(yīng)該僅是當(dāng)前的描述。

規(guī)則3：JavaDoc中不得道歉

不要在JavaDoc中解釋為什么不贊成使用該方法。 您是負(fù)責(zé)任的開發(fā)人員。 這是你的決定。 您做出了選擇。 其他人必須忍受它。 如果您愿意，可以寫一篇關(guān)于建筑決策背景的博客。 這可能會(huì)有所幫助，但是JavaDoc并不是放置它的地方。

不推薦使用的API JavaDoc僅用于解釋如何不使用。

重點(diǎn)是如何 。 不是“為什么不使用它”。

規(guī)則4：不贊成使用

如果您想棄用一種方法，那就去做吧！ 如果您害怕用戶，并且不想讓他們的生活悲慘地棄用某種方法，那么此決定將使您的生活變得悲慘。 采取所有措施以擁有盡可能長的時(shí)間不需要棄用的API。 但是，如果需要棄用某些東西，請立即扔掉。 不要感到內(nèi)，為什么在設(shè)計(jì)api時(shí)就看不到未來。 我們誰也看不到未來完美。 畢竟，生活對未來充滿了無聊。

如果您對stakcoverflow有關(guān)此主題的意見感興趣，請?jiān)L問鏈接的頁面。 或者，如果您愿意，也可以在這里開始一場火焰大戰(zhàn)。 我非常

參考： Java Deep博客上的JCG合作伙伴 Peter Verhas以不正確的方式使用了Java注釋 。

翻譯自: https://www.javacodegeeks.com/2014/02/use-java-annotation-deprecated-the-right-way.html

java 方法注解

總結(jié)

以上是生活随笔為你收集整理的java 方法注解_使用Java注解不正确的方法的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。