Java 在课堂描述中要写什么

我的问题是如何描述一个班级？当您在bluej中启动一个类时，总会有一个文档注释来描述该类。在描述中要写什么

---

例如，我有一个名为Economy的类，它扩展了一个抽象类结构，而抽象类结构实现了一个Basic接口。那么，我应该在阶级经济的描述中写些什么呢

首先要了解的是。。。实际上，人们应该写尽可能少的评论。相反：编写可以阅读、理解和使用的代码，而不需要（大量）附加注释

示例：您选择的“结构”和“基本”名称非常。。。无意义的这些名称并不能说明人们可以从相应的类和接口中预期的行为

问题是：评论是谎言。它们为您的源代码增加了额外的质量；但是一种无法自动检查的质量。因此，这些信息很容易与代码实际所做的事情不同步

---

换句话说：在一个类上放一个空的或很短的描述是完全可以的。除此之外，还有一种方法可以指导你在每门课上“只承担一项责任”。因此，“类描述”的核心点是命名/描述相应类的一个职责

想想如果有人想使用你的类，他们需要知道什么，或者如果有人不知道你的类做了什么，你会给他们一个类的基本描述。为什么会有人用你的课？它有什么作用

@Jägermeister提到了代码注释是多么容易出错，所以请确保无论您编写什么，都要用您的代码来更新它。如果更改了类，请确保也更改了对类的描述。如果你的描述要简短，你很可能只需要几行或更少的话

---

如果你发现自己写了几行描述，那么看看你的课堂，问问自己是否做得太多可能是个好主意。在这种情况下，最好让另一个类承担一些职责。

让开发人员寻找一个可以帮助您完成任务的类。然后您会发现类

Economy

。。。你现在想知道什么？也许这门课的目的是什么？应该如何使用？如果它是不可变的和/或线程安全的（这对于您的目的来说可能太多了）和其他东西。考虑其他开发人员以及他们需要了解的关于您的类的信息。然后写出来。我建议检查JDK和其他库中现有的Javadoc，以了解类描述中有用的内容。@Tom，但我从来没有真正理解到底要写什么。。。。。你能举个例子吗……也许再举个例子。@Stefan。。。。。。。我可以写一下，我的经济舱基本上是指乘坐经济舱飞机的费用。。。。。。但我想这是我在课堂上使用的方法的描述。我可以写下我的经济舱基本上是计算乘坐经济舱飞机旅行的费用。。。。。。但我认为这是我在课堂上使用的方法的描述另一个很好的例子：你的名字“经济”丝毫没有暗示它是关于计算费用的。如果你真的对学习如何以更好的方式做事感兴趣，我建议你在网上搜索罗伯特·马丁的“敏捷原则和模式……C#”。那本书的PDF可以从网上找到。。。仔细看一看他介绍的“案例研究”。阅读第26章可能会让你了解，只有良好的类/接口命名才能告诉你发生了什么。我应该写这篇文章，因为这是我项目航空预订的一部分，，，，让我简单地向你解释一下这个项目：我应该使用它，因为它是我项目机票预订的一部分。让我简单地向你解释一下这个项目：我应该创建一个基本接口，声明我将使用的所有方法。然后是一个抽象类结构，它实现了接口，并具有接下来三个类的通用方法，即经济类、业务类、高级经济类这是我的项目，这就是为什么我要给经济舱命名的原因