blocks|key|4950869|text|JavaDoc主要用于记录类的接口。JavaDoc注释必须在类、字段、构造函数或方法声明之前。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4950870|静态初始化器不是接口的一部分。它是类实现的一部分。|4950871|如果需要，您可以在类文档中记录它的行为。|4950872|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|H|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|I|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|J|8|@]|9|@]|A|$]]|$1|F|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|G|$]]

JavaDoc is intended primarily to document the interface of the class. JavaDoc comments must precede a class, field, constructor or method declaration. 

A static initializer is not part of the interface. It's part of the implementation of the class. 

You could document its behavior in the class documentation, if desired.

blocks|key|4950905|text|我想说的是，文档的重要部分应该移到类的文档中：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|4950906|/**
+*+Your+text+here.
+*/
public+class+SomeClass+{
+++static+{
++++++/*+your+static+initalizer+*/
+++}
}|code-block|syntax|javascript|4950907|entityMap^0|0|0^^$0|@$1|2|3|4|5|6|7|I|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|J|8|@]|9|@]|A|$E|F]]|$1|G|3|-4|5|6|7|K|8|@]|9|@]|A|$]]]|H|$]]

I'd say the important parts of that documentation should be moved to the class' documentation:

<pre><code>/**
 * Your text here.
 */
public class SomeClass {
 static {
 /* your static initalizer */
 }
}
</code></pre>

blocks|key|3165427|text|首先也是最重要的，静态初始化器是不是一开始就是很好的做法，这是有争议的。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|3165428|如果您仍然决定使用它们，我会在类级别将文档添加到JavaDoc。静态初始化器可能会产生副作用，具体取决于它们的实现方式。如果您使用有副作用的静态初始化器，则应该为所述类的使用者记录该行为。|offset|length|style|BOLD|3165429|entityMap^0|0|O|1Y|0^^$0|@$1|2|3|4|5|6|7|J|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|K|8|@$D|L|E|M|F|G]]|9|@]|A|$]]|$1|H|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|I|$]]

First and foremost, it's arguable if static initializers are good practice to start with.

If you decide to use them nevertheless, I'd add the documentation to the JavaDoc at the class level. Static initializers can, depending on how they're implemented, cause side-effects. If you use static initializers with side-effects, the behaviour should be documented for the consumer of said class.

blocks|key|2880148|text|Java语言中没有静态构造函数(as+oposed+to+C#)，这就是为什么必须在类级别记录这种行为的原因。|type|unstyled|depth|inlineStyleRanges|entityRanges|offset|length|data|2880149|此外，由于静态初始化器很可能会初始化一些静态字段，因此如果这些字段是公共的、受保护的(或包私有的，取决于您的JavaDoc可见性约定)，则应该根据静态初始化器的行为添加有关这些字段初始化方式的详细信息。|2880150|entityMap|0|LINK|mutability|MUTABLE|url|http://msdn.microsoft.com/en-us/library/k9x6w0hc%2528v=vs.80%2529.aspx^0|G|F|0|0|0^^$0|@$1|2|3|4|5|6|7|N|8|@]|9|@$A|O|B|P|1|Q]]|C|$]]|$1|D|3|E|5|6|7|R|8|@]|9|@]|C|$]]|$1|F|3|-4|5|6|7|S|8|@]|9|@]|C|$]]]|G|$H|$5|I|J|K|C|$L|M]]]]

There is no such thing as a static constructor in Java (<a href="http://msdn.microsoft.com/en-us/library/k9x6w0hc%28v=vs.80%29.aspx" rel="nofollow">as oposed to C#</a>), which is why you must document this behavior at the class level.

Also, since the static initializer will most likely initialize some static fields, if these fields are public, protected(, or package-private, depending on your JavaDoc visibility convention), you shold add details about the way these fields are initialized based on the behavior of the static initializer.

I have refactored a class and moved some code from the constructor to a static initializer. What should I do with the javadoc that was on the constructor? Is it possible to add javadoc to a static initializer?

How can I add javadoc to a static initializer in Java?

翻译质量差，导致语言生硬或混乱。

没有提供实际的解决方法或示例。

解答不清晰，无法理解或解决问题。

页面排版不美观，阅读体验差。

文章

问答

视频

学习中心

腾讯云实验室

直播

竞赛

腾讯云代码分析专区

腾讯iOA零信任安全管理系统专区

腾讯云架构师技术同盟交流圈

腾讯云数据库专区

腾讯云顾问专区

腾讯云原生专区

腾讯混元专区

腾讯云TCE专区

腾讯云Lighthouse专区

腾讯云HAI专区

腾讯云Edgeone专区

腾讯云存储专区

腾讯云智能专区

腾讯轻联专区 

腾讯云开发专区

TAPD专区

腾讯轻量云游戏服专区

腾讯云最具价值专家

腾讯云架构师技术同盟

腾讯云创作之星

腾讯云开发者先锋

腾讯云代码助手

云原生构建

TAPD 敏捷项目管理

Cloud Studio

SDK中心

API中心

命令行工具

涵盖代码开发、场景应用、自动测试全流程，助你从零构建专属AI助手

一站式MCP教程库，解锁AI应用新玩法

我重构了一个类，并将一些代码从构造函数移到了静态初始化器中。我应该如何处理构造器上的javadoc？可以将javadoc添加到静态初始化器中吗？

问如何在Java中将javadoc添加到静态初始化器？
EN

Stack Overflow用户

社区

活动

圈层

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问如何在Java中将javadoc添加到静态初始化器？EN