什么是Java中的方法規范

Question

我還學習Java的一位朋友問我：“ Java中的方法規范和方法簽名之間有什么區別？”

我知道什么是方法簽名，它是一個方法名稱及其參數methodName(int n, String str)例如

但是，到底什么是Java中的方法規范？

我在Internet上找到的所有內容-僅是pdf文件 。 以下是有關方法規范的信息：

1. 定義方法的包和類的名稱。
2. 用於調用它的方法標識符。
3. 其參數； 即您必須將哪些數據作為參數傳遞。
4. 它的作用及其返回值（如果有）。
5. 無論是實例還是類方法

因此，據我所知，方法規范包括包名稱（例如package com.site.progect ），方法簽名（ methodName(int n, String str) ），訪問規范（ private ， protected ，default或public ），返回類型值， static標識符（如果該方法是靜態的並且不屬於實例）。

方法規范是否包括在我們的方法定義所在的類的名稱？ 它是否包括在方法簽名之后... throws Exception()的指示（ ... throws Exception() ）？ 它是否包括開發人員對該方法的功能的評論？

Answer 1

關於兩個不同的概念可能會感到困惑。

1. 一個是一個什么樣的方法應該是一個（自然語言）的說明。 它用英語（或任何其他語言）描述了該方法的目標，可能是（但不一定是）其參數和返回值。

2. 第二個是在Java語言規范中僅在有關抽象類的示例中使用過一次，但從未正式定義過的短語。

用法＃2 似乎基本上是指方法簽名和方法的返回類型。

換句話說，雖然methodName(int n, String str)是方法的簽名，但根據含義＃2，一個可能的“方法說明”將是Object methodName(int n, String str) 。

Answer 2

方法規范可以看作是方法的文檔。 您可以這樣寫：

/**
 * Method - Description of the method
 * @param int n - description of parameter
 * @param String str - description of parameter
 * @return int - description of the return value
 **/
int methodName(int n, String str)
{
 ...
}  

該語法將用於生成javadoc。 您可以在此處查看更多詳細信息