如何描述课程是我的问题？当你在bluej中开始一个类时，总会有一个关于类描述的文档注释。在那个描述中写什么？
例如，我有一个名为Economy的类，它扩展了一个抽象类Structure，抽象类Structure实现了一个接口Basic。那么我应该在经济舱的描述中写些什么呢？
答案 0 :(得分：3)
首先要理解的是......实际上应该尽可能少地写出评论。相反：编写可以阅读，理解和使用的代码，而不需要（大量）附加注释。
示例：您选择的名称＆＃34;结构＆＃34;和＆＃34;基本＆＃34;非常......毫无意义。这些名称没有说明人们可以从相应的类和接口中获得的预期行为。
事情是：评论谎言。它们为您的源代码添加了额外的质量;但质量无法自动检查。因此，这些信息很容易与代码真正所做的事情不同步。
换句话说：在课堂上放置一个空的或非常简短的描述是完全可以的。除此之外：还有SRP可以为您提供指导，并且只提供一项责任＆＃34;进入每个班级。所以，＆＃34;类描述＆＃34;的核心要点将命名/描述相应类的一个责任。
答案 1 :(得分：0)
想想如果他们想要使用你的课程，或者如果他们不知道它做了什么，你会给某人的基本描述。为什么有人会使用你的课程？它有什么作用？
@Jägermeister提到了错误的代码注释可能是什么，因此请确保无论您编写什么，都要使用代码所做的更新。如果您更改了课程，请确保同时更改课程说明。并且保持您的描述相当简短，您最有可能只需要几行或更少。
如果你发现自己写了几行描述，那么看一下你的课程可能是一个好主意，并且问问自己是否试图做太多。在这种情况下，让另一个班级接受它的一些职责可能是一个好主意。