gpt4 book ai didi

java - 在记录 Java 程序时,记录类的约定是什么?

转载 作者:行者123 更新时间:2023-12-01 18:27:50 31 4
gpt4 key购买 nike

我知道对于方法,提供了解释以及@param、@return 和@throw。但是对于类来说,除了类的解释之外,还有什么特别需要包含的东西吗?

最佳答案

在类级别,文档应该解释:

  1. 为什么/什么时候我想使用这个类?
  2. 如何使用此类(示例)
  3. 这个类(class)与其他类(class)相处如何?
  4. 这门课有什么意外/特别之处? (线程安全、全局变量……)

总而言之,类文档应该提供更广泛的 View ,显示类如何适应代码的其余部分。

关于java - 在记录 Java 程序时,记录类的约定是什么?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/25407310/

31 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com