我們應該擴展抽象類的JavaDoc類嗎？

Question

假設我正在寫一個擴展抽象類「Work」的類「MyWork」。現在，假設我在「MyWork」中需要的所有方法都已經被聲明，並且他們的JavaDoc被寫入「Work」。我還應該在「MyWork」中添加JavaDoc嗎？

乾杯！

Answer 1

除非MyWork中的方法覆蓋Work中的任何功能，否則可以安全地推測這些方法的行爲與它們的超類相似。應該沒有任何理由記錄未覆蓋的方法或字段。

Answer 2

我假設你在談論抽象方法，所以「MyWork」類需要重寫它們。

如果它們沒有任何特殊行爲，則不需要添加新的JavaDoc。否則，請記錄他們如何實現抽象方法。通常，必須有一個原因，說明此方法是抽象的，必須在繼承類中實現，並且不在抽象類本身中實現。

您可以使用{@inheritDoc}獲取繼承的Doumentation的文本，然後在其下面添加特殊行爲。

Answer 3

這取決於。如果您不覆蓋任何方法，則無法添加Javadoc（僅限於課程級別）。向班級中添加一些Javadoc可以解釋爲什麼它存在。

如果你覆蓋的方法，你可以寫的Javadoc這樣的：

/** 
* {@inheritDoc} 
* This implementation also does... 
*/ 

Answer 4

對於非公共代碼，我不會與任何@inheritDoc不處理打擾。