java类描述中要写什么

Question

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

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

Answer 1

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

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

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

换句话说：在一个类上放一个空的或很短的描述是完全可以的。除此之外，还有SRP为您提供指导，指导您在每个班级中“只承担一项责任”。因此，“类描述”的核心点是命名/描述相应类的一个职责

Answer 2

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

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

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