java - Sonar : Array should contain trailing comma

Question

Sonar 向我展示了一个小的工作用语:

- 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 }),

为什么我应该插入尾随逗号？

Answer 1

Why should I insert a trailing comma?

你不需要。我怀疑 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");

考虑如果不允许尾随逗号，那么该代码会是什么样子。您将不得不单独处理最后一个元素。所以，它只是对代码生成器有好处。