gpt4 book ai didi

简单构造函数的 Javadoc 注释。需要还是不需要?

转载 作者:塔克拉玛干 更新时间:2023-11-03 04:35:54 24 4
gpt4 key购买 nike

<分区>

给定以下代码片段:

/**
* Initializes a new instance.
*
*/
public Collector() {
this.map = new HashMap<>();
}

请关注 Javadoc 评论:在这个构造函数中并没有发生太多事情。那么,为它编写 Javadoc 的正确方法是什么?如上图?这将是完全准确的,但同时又是多余的,因为构造函数旨在初始化一个新实例。

所以,一方面,我们不想在 Javadoc 注释中写冗余信息,另一方面,Javadoc 注释必须要有(有吗?)。

那么,简而言之,在这种情况下如何编写有意义的,而不是多余的 Javadoc?

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