Java 是否可以为重载方法获取相同的文档?
我正在寻找用重载方法制作文档的最佳方法 我有两种方法:Java 是否可以为重载方法获取相同的文档?,java,javadoc,overloading,Java,Javadoc,Overloading,我正在寻找用重载方法制作文档的最佳方法 我有两种方法: /** * does something * @param A * @return result */ public String methodA(Type1 A); /** * does something * @param A * @return result */ public String methodA(Type2 A); 由于两个方法都呈现相同的内容,是否可以将文档集中在一个采用对象参数的方法上?还是有更好的方法呢?我认
/**
* does something
* @param A
* @return result
*/
public String methodA(Type1 A);
/**
* does something
* @param A
* @return result
*/
public String methodA(Type2 A);
由于两个方法都呈现相同的内容,是否可以将文档集中在一个采用对象参数的方法上?还是有更好的方法呢?我认为您编写一种“通用”文档的初衷并不是一成不变的。您至少需要注意参数和返回值 还是有更好的方法 为了避免实际文档的冗余,可以使用标记
如果该方法需要大量文档,例如方法,那么这一点尤其有用。我认为您编写一种“通用”文档的初衷并不是开箱即用的。您至少需要注意参数和返回值 还是有更好的方法 为了避免实际文档的冗余,可以使用标记
如果该方法需要大量文档,例如方法,这一点尤其有用。您是在谈论javadoc吗?您可以使用泛型,但我想这对于集中文档来说有点太麻烦了!@Shreyos Adikari是的,有JUnit。Javadoc没有这样的机制,没有。。。必须检查方法参数。您可以使用
@link
标记将一个方法链接到另一个方法。这避免了实际文档的冗余(“做点什么”)。您是在谈论javadoc吗?您可以使用泛型,但我想这对于集中文档来说有点过于繁重了!@Shreyos Adikari是的,有JUnit。Javadoc没有这样的机制,没有。。。必须检查方法参数。您可以使用@link
标记将一个方法链接到另一个方法。这避免了实际文档的冗余(“做某事”)。