|
|
1
1
我总是在方法名中使用“更新”一词来表示结果将更新一个或多个参数。对于EX:
你可以合理地推断出这个方法 可以 更新索赔对象。如果用户想了解更多信息,就可以深入了解javadoc 对于返回某些内容并更新参数的函数,可以使用“updateandget”。
由此,您可以推断您正在更新索赔并返回保险单(索赔可能已经针对保险单进行了更新)。 如果一个方法中没有使用updateXXX这个词,那么您应该假设所有参数都是只读的。如果你有两个可更新的参数,那么你可以说
上面可以告诉您索赔和保险单标准都将更新。 |
|
|
2
0
将此信息编码到方法名中可能很复杂。 另一方面,这个信息 必须 通过明确说明方法的副作用,在方法的文档中存在(例如在JavaDoc上)。 |
|
|
3
0
我喜欢上面关于预挂起更新或修改的回答。然而,这实际上应该是文档的一个函数,用来描述调用函数的作用以及它如何影响参数。但是,通常您不希望修改传递给函数的参数,因为在某些情况下(如collections.sort),您希望这样做以防止复制。另外,确保在适当的时候使用不可变的对象,而不是总是使用一些公共的吸气剂和设置器使用一些愚蠢的JavaBean类。 |