Java “最佳编码（布局）实践”；main（）类；文件

目前，我的“main（）class”文件看起来有点像下面的代码。我没有用//注释将这个示例代码凌乱起来进行讨论，而是简单地用数字（1到4）标记了四行代码，这些数字表示代码后面出现的问题。多谢各位

// package myPackage;  // **1**

import myOtherPackage.*;

class mainProject{  // **2**

    // **3**
    private int myVar;

    mainProject(){
        myVar = 0;
    }

    public static void main(String args[]){

        // Keep main() looking fairly simple?
        // Perhaps just have some "essentials" here, such as error handling?

        new mainProject().start();  // **4**
    }

    private void start(){
        // The project gets going here..
    }
}

1与项目中的其他类文件不同，我没有为我的“main（）类”文件指定包名。这是一个糟糕的设计选择吗

2对于“主类”是否有良好的命名约定？将单词“main”合并到此类名中是否有帮助？大概像“mainProject”这样的东西是个好主意吗

3各种编码结构可以出现在主类文件中。例如，局部变量、构造函数、main（）方法和局部方法。他们在该文件中的显示顺序是否为“最佳顺序”

---

4保持main（）方法看起来相当“精简和简单”值得吗？在本例中，我刚刚调用了一个名为start（）的本地私有方法，用于启动项目。

1是的，您应该始终使用包。但是不要在它们中使用camelcase。。。因此，我选择了myotherpackage而不是myotherpackage

2是的，合并单词main是一种很好的习惯，例如MyApplicationMain。记住，类名以大写字母开头

3是的，常见的顺序是静态、成员、构造函数、方法，就像你已经做过的那样

4是的！这可以实现更好的测试，并且静态上下文的使用时间不应超过需要的时间

如果你添加一个软件包，并接受我的大写字母提示，我认为你上面的内容绝对是好的

通常，最好定义自己的包，以避免与类路径上的任何其他类发生命名冲突。这也适用于主类。想象一下，如果依赖项中的其他地方有一个类，其创建者使用相同的方法将其保留在默认包中，会发生什么情况。是的，把它放进一个包裹里

命名由您自己决定，但Java编码惯例明确要求您将类名大写。因此，

Main

或

MainProject

或

EntryPoint

将是更好的选择

我认为您将字段和方法称为类的成员。请注意，局部变量和局部方法具有完全不同的含义（它们不是类本身的成员）。通常的顺序是静态字段、实例字段、静态方法构造函数、实例方法。我不认为有一个强大的惯例，但这些是习惯

保持任何方法干净、简单都是值得的；）

• 始终使用

  软件包

  。不管怎样。这是您的名称空间

• 不要在包名称中使用

  camelCase

• 避免导入整个

  包。*

  ，最好导入单个

  包。Clazz

• 类名应始终为

  大写和CAMELCASE

• 在类或方法名称和开头栏之间留一个空格，这样可以提高可读性

剩下的似乎没问题。这或多或少是一个实用主义的问题。您的代码必须满足其编写目的，还需要可测试性和可读性（由其他人）

所有这些标准将构成您或您的团队的规则集

如果其他人有一个同名的主类呢？最好将它放在一个包中，用于除最简单的测试程序之外的所有测试程序

在类名中加入“Main”是一个好主意，因为它可以快速告诉读者类的用途，但是根据

是的，保持main方法小且易于阅读。其中的逻辑应该主要与传递给程序的参数相关，甚至当它变得太大时，也应该考虑到这一点

---

好的，以下是我在专业项目中的做法

对于1.每个类都应该有一个包。Main或no Main没有区别。package是java在运行时以名称空间的形式组织类的方式。因此，如果停止提供包，那么最终可能会在同一文件夹或jar中有两个同名的类文件，当这种情况发生时，JVM会根据名称选择它找到的第一个类类路径。这可能不是您想要的

对于2.main（特别是

publicstaticvoidmain（String[]args）

是Java需要的一个特定的标准签名。任何可运行的程序，一个产生输出并可以执行的程序，都需要一个带有此签名的main方法。我将尝试解释签名，这可能会帮助您理解为什么会是这样

它是公共的，因为您希望JVM运行时代码执行该方法。使用

private

或

protected

将不允许JVM代码看到您的方法

它是静态的，因为如果没有

static

，JVM代码将需要类的实例来实际访问方法。请记住，静态方法和字段可以通过使用类名来访问。但是非静态成员需要有效的活动对象来访问它们

它是void，因为main不向其调用者返回任何内容，就像任何具有void返回类型的方法一样

它被称为

main

，因为Java创建者想给它起这个名字。执行这个方法的JVM运行时代码需要知道启动执行的方法的名称。现在，如果我给它起任何名字，那么JVM代码就不可能胡乱猜测了。因此名称标准化需要一个标准名称和Java创建者坚持使用

main

String[]

i

public class MyClass{

    //private members

    //protected members

    //constructors

    //private methods

    //protected methods

    //public methods

    //hashcode and equals

    //toString overrides
}