Java静态谓词命名约定

问题描述 投票:1回答:1

假设我要在isSubdirectory助手类中编写FileUtils静态函数。该函数如下所示:

class FileUtils {
  public static boolean isSubdirectory(File child, File parent) {
    // ...
  }
}

或者我可以翻转parentchild参数:

class FileUtils {
  public static boolean isSubdirectory(File parent, File child) {
    // ...
  }
}

而且我不能选择哪个顺序正确...

在Kotlin中没有任何疑问:只需声明扩展功能:

fun File.isSubdirectory(parent: File) {
  // ...
}

[着眼Kotlin我发明了助记符规则:静态函数中的第一个参数应被视为this(我不是第一个发明此规则的人。我看到很多人也在使用它)。因此,在此示例中,我希望将child放置为第一个参数。

但是问题是:此规则是否已经正式化并具有众所周知的名称?我厌倦了向不知道该规则的人重复此规则,希望我可以简单地用它的名字来指称此规则。

java kotlin static predicate
1个回答
0
投票

我不确定是否有名称或任何正式形式。充其量,让第一个参数看起来像this只是一种惯例。尽管很少见,“最后”约定也存在,在C和早期C ++中更常见(示例:具有fread / fwrite的stdio)

也存在基于参数类型的约定;例如,提升以下顺序:

  • 集合和具有通用参数的其他对象
  • 对象数组
  • 没有泛型的对象
  • String
  • 原始类型的数组,例如byte[]
  • 双精度浮点数
  • 长,整数,短,字节
  • boolean

也或多或少地存在相反的顺序。其他约定也倾向于按参数类型对参数进行分组,它们倾向于method(String, String, int, int)而不是method(String, int, String, int)

如您所见,存在许多约定。我不确定它们中的任何一个都具有名称,并且真的比其他任何名称都使用得更多。例如,这并不像camelCase与snake_case一样清晰,几乎没有人矛盾。

您可以从以下所有内容中避免:按您认为最合理和最直接的顺序排列参数。最重要的是要保留在整个项目中,即,不要写isFileX(a,b),然后再写isFileY(b,a),例如,如果这两种方法在同一类中,则不要写过。如有疑问,请不要犹豫,问其他从事您项目的人他们认为最好的是什么。

对于您的特殊情况,由于“ this first”规则,将孩子放在第一位是合理的,但是将父对象放在第一位也是合理的,因为这也是GUI框架中的常见约定。由您决定。

© www.soinside.com 2019 - 2024. All rights reserved.