声纳:数组应包含尾随逗号

2022-09-03 05:39:23

声纳给我看了一句小话:

- Array Trailing Comma
Array should contain trailing comma.

我的代码包含:

RECOVER_PASSWORD(new String[] {
        RequiredPermissions.USERS_PASSWORD_RECOVER,
        RequiredPermissions.USER_RETRIEVE,
        RequiredPermissions.API_USER_RETRIEVE,
        RequiredPermissions.ONETIMELINK_CREATE,
        RequiredPermissions.API_ONETIMELINK_CREATE,
        RequiredPermissions.PASSWORD_RECOVER,
        RequiredPermissions.API_PASSWORD_RECOVER }),

为什么要插入尾随逗号?


答案 1

为什么要插入尾随逗号?

您不需要这样做。我怀疑Sonar应该只是在那里显示警告。

这取决于程序员的偏好,他喜欢什么。在数组末尾添加尾随逗号,可以轻松地在以后从数组中删除或添加任何条目。

所以,如果你有一个这样的数组:

String[] arr = new String[] {
                  "abc",
                  "def",
                  "ghi",
               }

添加条目只需要在数组末尾添加带有尾随逗号的条目。如果没有逗号,您首先需要添加一个逗号,然后添加元素。

删除元素只需要您删除包含该元素的那行。或者只是注释掉那行。

String[] arr = new String[] {
                  "abc",
                  "def",  
              //  "ghi",    // This won't cause any error
               }

如果不允许尾随逗号,那么如果您删除最后一个元素,则必须删除它前面的逗号。好吧,我知道这个理由很荒谬。但这只是允许的。


这对于代码生成器在生成数组初始化代码时非常有益。他们可以简单地继续在数组中添加带有尾随逗号的元素,而不必担心它是否是最后一个元素。

让我们举个例子:

StringBuilder array = new StringBuilder();

array.append("int[] arr = new int[] {").append("\n");
for (int i = 0; i < 10; ++i) {
    array.append(i + ",").append("\n");
}
array.append("}").append("\n");

考虑一下,如果不允许使用尾随逗号,那么该代码的外观会是什么样子。您必须单独处理最后一个元素。所以,它只是对代码生成器有好处。


答案 2

JLS (§10.6) 规定

尾随逗号可能出现在数组初始值设定项中的最后一个表达式之后,并被忽略。

这绝不是必需的。

但是,它在某种程度上是一种样式选择,它可以使最后一个元素的重新排序,操作和/或复制粘贴变得更加容易。移动到另一个地方或粘贴到它下面的新条目中可能会更容易,因为您不需要添加额外的逗号,也不会因键入错误或错误点击而导致语法错误。RequiredPermissions.API_PASSWORD_RECOVER