註釋或不註釋

Question

我正在考慮註釋我的域對象。這將減輕DO的操縱。保持域代碼免於其他外部事物對我來說也很重要。

通過添加註釋來評論域代碼的「腐敗」？

你是否爲域對象添加註解？爲什麼？

Answer 1

註解（與大多數的東西一樣）有折衷。最大的問題是它們是靜態的。如果您想在運行時更改註釋中表示的屬性，那麼您運氣不好。

當你涉及到涉及的場景時（特別是在處理註釋的註釋時），他們可能會遇到一些困難。

如果你有很多他們，他們可能會使代碼不可讀。

然而，在適度，保持簡單和正確的情況下，他們確實可以使代碼和配置更簡單和更清晰。

Answer 2

我認爲註釋是否使代碼更簡單是一個好主意，但是，您應該查看已經存在的內容，並且至少使用可能是標註名稱的標準。例如，您可以查看JDBC 4.0，Java（http://onjava.com/pub/a/onjava/2006/08/02/jjdbc-4-enhancements-in-java-se-6.html?page=2）或Spring作爲示例。

這會做兩件事。一個是，如果你決定在某些時候使用這些註釋，並擺脫你自己的註釋，那麼你的代碼不會改變。二，它縮短了其他人的學習曲線。

你的註釋可能不會進入數據庫，但是有很多註釋模型在那裏，只要確定你是否創建了自己的新名稱，你正在做的事情足夠獨特，否則它就會讓那些需要閱讀你的代碼。

Answer 3

看看Terracotta - 很可能你不必編寫自己的註釋。我們被提出了類似的困境（我們的DOs不打算用於關係數據庫）和兵馬俑竟然是一個真正的生活救世主

Answer 4

我們使用註解的具體事情 - 即特殊處理的字符串等 - 和它的作品像一個魅力。註釋是處理「元數據」類信息的好方法 - 有關數據對象的數據。我建議查看當前的J2EE註釋（我認爲它是版本5.0？），因爲大多數ORM系統（即Hibernate等）都使用它。

Answer 5

我更喜歡我的註釋是描述性的而不是功能性的。例如，JCIP併發註釋描述有關類的信息，但不提供其中的功能。導致功能性的註釋往往是PFM（純粹的魔法），使代碼更難理解。

這不是一個硬性規則，但當註釋執行一些功能性配置和配置文件（如XML）處理其他配置時，這是一種痛苦。它導致代碼要求你遍佈各處並理解事情應該如何工作的多種配置方案。