Question

我喜欢稍微组织我的Java文件，并想知道是否有标准的方法来执行此操作。例如：

public class Example
{
    private int exampleInt;
    private String exampleString;

    /*------------------------------------------------------------*/
    /* I N N E R   C L A S S E S                                  */
    /*------------------------------------------------------------*/
    private someInnerClass 
    {
            someInnerClass()
            {
            }
    }
    /*------------------------------------------------------------*/

    /**
    * This method returns the example int.
    */
    public int getExampleInt() {
            return exampleInt;
    }
}

我没有什么可以称之为我有一种评论中断的部分 / ---------------------------------------------- ------------------- / 这种事情有什么样的惯例吗？或者这是我不应该做的事情，因为大多数IDE会在某种大纲视图中很好地展示你的一切？

Answer 1

代码解释了自己。没有必要把这些丑陋的长评论行放进去。如果你真的需要，那就把它们缩短，就像这样：

// -------------
// Inner Classes
// -------------

这不那么混乱。当我遇到这些显而易见的评论时，我通常会在那里删除它们。

Answer 2

重构和源清理可能会导致重新组织源文件，包括注释。

我建议你不这样做，因为那个评论可能会在某个完全不相关的地方结束。

您可能想要尝试的另一件事是使用IDE重新格式化源代码。 Eclipse允许每次保存文件时都这样做。这将为您的所有代码提供一致的外观，以便于阅读。

Answer 3

您应该查看Javadoc工具的注释约定，Netbeans和其他IDE用于将它们作为代码工作方式的主要描述，并且应该没有问题地概述它

How to Write Doc Comments for the Javadoc tool

Answer 4

我倾向于发现像你的例子那样的评论作为眼睛疼痛。如果你正在对内部类进行分组就足够了;没有理由产生额外的噪音。此外，任何可敬的IDE（Eclipse，IntelliJ等）都会为您列出，过滤和分组代码的结构元素。

Answer 5

要回答你的问题，我不相信会有这样的约定。

Sun的Code Conventions for Java当然没有提到这样的事情。

我的建议只是不要这样做。在我的项目中，我们只是在类型级别提供格式正确的JavaDoc注释，为关键API方法（主要是接口上的公共方法）提供方法级别JavaDoc，并在特定实现特别足以值得记录时提供具体方法。

这是我认为初级开发人员（包括我自己）喜欢做的事情，但后来才意识到这是一个额外的负担，并没有真正增加那么多的价值。

Answer 6

我建议删除这些行注释。他们只是杂乱无章。空白是更有效的IMO，因为它在视觉上引发了代码块，并没有弄乱源代码。

Answer 7

以下是需要考虑的事项：如果您团队中的某个人不想遵循您的评论中断惯例，那么阻止他们将他们的方法放在他们喜欢的地方是什么？如果他们确实错位了一种方法，你会怎么找到它？注释中断不会强制遵守，因此您无法信任它们。那么，如果您最终会使用IDE的优秀功能来查找方法，那么为什么不从一开始就这样做呢？

总结一下，是的，如果你愿意，你可以这样做，但这不是分割代码的可靠方法。

Answer 8

我知道没有普遍接受的章节分隔符约定。有些人喜欢他们（我碰巧是其中一个人），有些人认为这些是不必要的分心。这两个群体都是对是错：这是个人品味的问题，不幸的是，对于一些开发者而言，这可能成为一个近乎宗教的问题（与编辑选择，语言选择等不同）。

我认为重要的是要保持一致并尊重其他开发人员，特别是在没有项目范围标准的情况下。如果您不是某个文件的主要维护者，但需要在那里进行更改，请尽量遵循已有的任何格式。

Answer 9

清除代码并删除不必要的注释。代码应该说明它自己做什么，记录公共类/接口，构造函数和作为API一部分的方法，使其清晰简洁。

是否存在Java的“行规则”的编码约定

9 个答案: