接口的Javadoc注释？_Java_Interface

接口的Javadoc注释？

java interface

接口的Javadoc注释？,java,interface,Java,Interface,我正在自学Java，希望得到关于这个问题的反馈：编写一个包含两个方法的Java接口，一个将两个double相加返回总和，另一个将两个double相乘返回乘积。使用JavaDoc注释我遗漏了什么吗？在接口的JavaDoc注释中包含@return是否合适 /** * This is an interface for basic math. */ public interface Math { /** * This method will be used to add two do

我正在自学Java，希望得到关于这个问题的反馈：编写一个包含两个方法的Java接口，一个将两个double相加返回总和，另一个将两个double相乘返回乘积。使用JavaDoc注释

我遗漏了什么吗？在接口的JavaDoc注释中包含@return是否合适

/**
 * This is an interface for basic math.
 */
public interface Math {

  /**
   * This method will be used to add two doubles.
   * @param a a value to be added
   * @param b the other value to be added
   * @return the sum of the two doubles
   */
  public double add(double a, double b);

  /**
   * This method will be used to multiply two doubles.
   * @param a a value
   * @param b the other value
   * @return the product of the two doubles
   */
  public double multiply(double a, double b);

}

是的，使用

@return

是合适的

您可以改进的事情很少：

要遵循Java编码约定，请以小写字母开始方法名称（例如，使用
```
add
```
而不是
```
add
```
）
有更好的参数名。例如。使用
```
number1
```
，
```
number2
```
代替
```
a
```
，
```
b
```

用大写字母开始

@param

和

@return

说明（例如

@param number1第一个数字

）

我认为说

返回两个给定数字的加法比更好。这个方法将用于添加两个双精度。

是的，使用@return
是合适的
您可以改进的事情很少：

要遵循Java编码约定，请以小写字母开始方法名称
（例如，使用add
而不是add
）
有更好的参数名。例如。
使用number1
，number2
代替a
，b
用大写字母开始@param
和@return
说明（例如@param number1第一个数字
）
我认为说返回两个给定数字的加法比更好。这个方法将用于添加两个双精度。


我遗漏了什么吗
目前的Javadoc没有任何根本错误或“缺失”
在接口的JavaDoc注释中包含@return是否合适
/**
 * This is an interface for basic math.
 */
public interface Math {

  /**
   * This method will be used to add two doubles.
   * @param a a value to be added
   * @param b the other value to be added
   * @return the sum of the two doubles
   */
  public double add(double a, double b);

  /**
   * This method will be used to multiply two doubles.
   * @param a a value
   * @param b the other value
   * @return the product of the two doubles
   */
  public double multiply(double a, double b);

}

这是绝对恰当的。接口是API的一种形式，API方法返回的值的含义是接口的一个基本方面。如果接口中没有指定方法返回值的含义，那么接口方法的调用方就不知道应该期望什么。这使得编程接口变得困难
我遗漏了什么吗
目前的Javadoc没有任何根本错误或“缺失”
在接口的JavaDoc注释中包含@return是否合适
/**
 * This is an interface for basic math.
 */
public interface Math {

  /**
   * This method will be used to add two doubles.
   * @param a a value to be added
   * @param b the other value to be added
   * @return the sum of the two doubles
   */
  public double add(double a, double b);

  /**
   * This method will be used to multiply two doubles.
   * @param a a value
   * @param b the other value
   * @return the product of the two doubles
   */
  public double multiply(double a, double b);

}

这是绝对恰当的。接口是API的一种形式，API方法返回的值的含义是接口的一个基本方面。如果接口中没有指定方法返回值的含义，那么接口方法的调用方就不知道应该期望什么。这使得界面编程变得困难。
请不要链接到代码图像。看，这基本上没问题。如果存在返回值，则应始终具有@return
。您需要生成Javadoc并查看结果如何才能真正做出决定。你可以省略“this is[a interface]”和“this method将用于”。一般来说，你可以在方法或类描述中添加一些小示例，使它们更容易理解。然而，在这种情况下，它几乎是不言自明的。请不要链接到代码的图像。看，这基本上没问题。如果存在返回值，则应始终具有@return
。您需要生成Javadoc并查看结果如何才能真正做出决定。你可以省略“this is[a interface]”和“this method将用于”。一般来说，你可以在方法或类描述中添加一些小示例，使它们更容易理解。然而，在这种情况下，这是非常不言自明的。number1
如何优于a
？@user207421，因为它说明了一些有关参数的信息add（number1，number2）
比add（a，b）
更有意义。它说明了参数是什么？这更有意义，为什么？到目前为止，这只是华夫饼。总的来说，我同意。你应该使用描述性名称。但是在使用add
方法的情况下，a
和b
是惯用的，并且比其他方法更具可读性。与坐标的x
，y
相同。还要注意的是，number1
和number2
实际上并没有更大的帮助，第一个和第二个可能会更好，具体取决于上下文。number1
比a
好多少？@user207421，因为它说明了一些有关参数的信息add（number1，number2）
比add（a，b）
更有意义。它说明了参数是什么？这更有意义，为什么？到目前为止，这只是华夫饼。总的来说，我同意。你应该使用描述性名称。但是在使用add
方法的情况下，a
和b
是惯用的，并且比其他方法更具可读性。与坐标的x
，y
相同。还要注意的是，number1
和number2
实际上并没有更大的帮助，第一个
和第二个
可能更好，具体取决于上下文。