gpt4 book ai didi

java - Java 中类实现文档注释的正确位置

转载 作者:行者123 更新时间:2023-11-30 10:48:05 26 4
gpt4 key购买 nike

<分区>

假设我正在用 Java 编写一些复杂的类,并且我想记录一些关于类的实现的事情(即类的用户不应该感兴趣的事情,而是希望修改类的实际实现的程序员)。

此外,假设我要编写的那些文档注释不特定于任何单个方法/字段,而是与类的整个实现相关。此类文档注释的最佳位置在哪里?

/** … **/ block 中类的声明之前写注释将使它们成为 Javadoc HTML 中类的主要描述的一部分,这是不好的 -因为我不想用这些信息打扰类(class)的用户。

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