java - Java 是否有 "line rule"的编码约定

标签 java coding-style

我想稍微组织一下我的 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 会在某种大纲 View 中很好地向您显示所有内容?

最佳答案

代码会自行解释。没有必要把这些丑陋的长注释行放在里面。如果你真的必须,那就把它们缩短,像这样:

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

这样就没那么乱了。当我遇到这些陈述显而易见的评论时,我通常会立即删除它们。

关于java - Java 是否有 "line rule"的编码约定,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/1176458/

相关文章:

java - Spring-Boot:Jmx 注释在库中不起作用

java - 具有两个不同扫描仪和两个不同 BufferedReader 的相同 TCP 套接字(客户端)

Scala风格: More than one class in a file?

c++ - 将参数传递给函数

python - 从函数返回多个值的最佳方法?

java - 如何将属性值注入(inject)过滤器?

JavaFX- 在 TableView 中居中选定的行

c# - 是否可以格式化工具提示文本(粗体、下划线...等)?

c++ - 在 C++ 中正确使用 "interfaces"?

java - 如何在两个不同的类中使用 getter 和 setter