java中的清洁方法声明

Question

我想编写干净的代码。所以在编写一个方法时，我想告诉调用者有关参数，返回类型，异常等的方法。当调用一个方法时，调用者应该已经知道方法是否可以返回null或者参数是否为null。

我可以在javadoc中解释这一点，但我想用注释做到这一点。我知道jetbrains，现在JSR305试图解决这个问题，但我认为它们还不够。

所以：

1. 是否有任何大的注释库，参数和返回类型

2. 是这个注释只针对代码只可读性，或者它抛出一个异常，如果一个意想不到的价值/运行时遇到结果？

3. 方法声明只应包括碱检查异常或亚类的它太像

   public void foo() throws ConnectionException, AuthenticationException { 
   } 
   
   public class AuthenticationException extends ConnectionException { 
   } 
   

Answer 1

这可能是也可能不是你心目中 - 设计 - 通过合同注解允许你指定的参数和返回的方法的类型必须满足一定的条件，被认为是正确的。看看cofoja：

Java合同使您能够以预处理，后置条件和不变式的形式对合同进行注释。

这些合同注解

• 易于读写，
• 并在运行时检查。

与合同注解代码可以帮助你：

• 设计，
• 文件，
• 测试和
• 调试

您的程序。

Answer 2

关于“3”：一种方法，文件应包括通过所述方法引发的所有可能的例外，即，选中并未检查。

关于“2”：注释不是允许在运行时抛出异常的机制。它们有三个主要目的：为编译器生成样板代码，文档和信息，从而生成警告。看看这里：

Annotations Tutorial

Answer 3

给我打电话给老学校。但是，这不是javadoc的用途吗？