草庐IT

non-javadoc

全部标签

java - JavaDoc 中的 {@code memberData} 和 <code>memberData</code> 有什么区别

{@codememberData}和有什么区别?和memberData在JavaDoc中 最佳答案 有两个主要区别:{@code...}更简洁:更易于阅读(和输入)。{@code...}内的文字将自动为您进行HTML转义。例如,{@codeList}相当于List<String>.另见thedocumentationfor{@code}. 关于java-JavaDoc中的{@codememberData}和memberData有什么区别,我们在StackOverflow上找到

java - JavaDoc 中的 {@code memberData} 和 <code>memberData</code> 有什么区别

{@codememberData}和有什么区别?和memberData在JavaDoc中 最佳答案 有两个主要区别:{@code...}更简洁:更易于阅读(和输入)。{@code...}内的文字将自动为您进行HTML转义。例如,{@codeList}相当于List<String>.另见thedocumentationfor{@code}. 关于java-JavaDoc中的{@codememberData}和memberData有什么区别,我们在StackOverflow上找到

java - 如何强制 IntelliJ 使用 Maven 下载 javadocs?

我对项目结构中的一些Maven条目有以下描述:Javadoc文件在文件系统中确实不存在。同时,它存在于中央存储库中。为什么没有下载,如何强制下载?更新这些选项已经开启:设置后尝试重新编译、关闭/打开等... 最佳答案 点击intelij右侧的“mavenprojects”(确保工具按钮已打开),然后点击“DownloadDocumentation”。另外,为了将来的下载,您可以转到文件->设置->构建、执行、部署->构建工具->Maven->导入->标记“文档”复选框并应用设置 关于ja

java - 如何强制 IntelliJ 使用 Maven 下载 javadocs?

我对项目结构中的一些Maven条目有以下描述:Javadoc文件在文件系统中确实不存在。同时,它存在于中央存储库中。为什么没有下载,如何强制下载?更新这些选项已经开启:设置后尝试重新编译、关闭/打开等... 最佳答案 点击intelij右侧的“mavenprojects”(确保工具按钮已打开),然后点击“DownloadDocumentation”。另外,为了将来的下载,您可以转到文件->设置->构建、执行、部署->构建工具->Maven->导入->标记“文档”复选框并应用设置 关于ja

Javadoc {@inheritDoc} 标签类

我想使用{@inheritDoc}类从我的抽象类继承方法。在抽象类的文档中,我按名称引用抽象类。当子类从父类(superclass)继承文档时,如何标记它,它将抽象类的名称替换为子类的名称? 最佳答案 javadoc生成工具不支持您所描述的内容。我认为这也有一个充分的理由:如果子类中的方法仅仅是抽象方法的实现,那么我认为将抽象类的名称留在其中是正确的。另一方面,如果您在子类中的方法不仅仅是一个简单的实现,并且做了更多值得注意的事情(足以在javadoc中提及),那么您应该在子类,而不是调用inheritDoc。

Javadoc {@inheritDoc} 标签类

我想使用{@inheritDoc}类从我的抽象类继承方法。在抽象类的文档中,我按名称引用抽象类。当子类从父类(superclass)继承文档时,如何标记它,它将抽象类的名称替换为子类的名称? 最佳答案 javadoc生成工具不支持您所描述的内容。我认为这也有一个充分的理由:如果子类中的方法仅仅是抽象方法的实现,那么我认为将抽象类的名称留在其中是正确的。另一方面,如果您在子类中的方法不仅仅是一个简单的实现,并且做了更多值得注意的事情(足以在javadoc中提及),那么您应该在子类,而不是调用inheritDoc。

java - 如何在 JavaDocs 中引用 "*/"

我需要在我的JavaDoc注释中包含*/。问题是这也是关闭评论的相同顺序。引用/转义这个的正确方法是什么?例子:/***Returnstrueifthespecifiedstringcontains"*/".*/publicbooleancontainsSpecialSequence(Stringstr)跟进:看来我可以使用/作为斜线。唯一的缺点是直接在文本编辑器中查看代码时,这并不是那么可读。/***Returnstrueifthespecifiedstringcontains"*/".*/ 最佳答案 使用HTML转义。所

java - 如何在 JavaDocs 中引用 "*/"

我需要在我的JavaDoc注释中包含*/。问题是这也是关闭评论的相同顺序。引用/转义这个的正确方法是什么?例子:/***Returnstrueifthespecifiedstringcontains"*/".*/publicbooleancontainsSpecialSequence(Stringstr)跟进:看来我可以使用/作为斜线。唯一的缺点是直接在文本编辑器中查看代码时,这并不是那么可读。/***Returnstrueifthespecifiedstringcontains"*/".*/ 最佳答案 使用HTML转义。所

用于私有(private)/ protected 方法的 JavaDoc?

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题吗?更新问题,以便editingthispost提供事实和引用来回答它.关闭8年前。Improvethisquestion我应该为private还是protected方法编写JavaDoc?那么私有(private)变量呢?我在我的Java书上看到了类示例,并且private变量是JavaDoc的。所以我不明白JavaDocprivate(或protected)方法是否是一个好习惯。 最佳答案 是的,您应该为私有(private)方法编写JavaDoc,即

用于私有(private)/ protected 方法的 JavaDoc?

关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题吗?更新问题,以便editingthispost提供事实和引用来回答它.关闭8年前。Improvethisquestion我应该为private还是protected方法编写JavaDoc?那么私有(private)变量呢?我在我的Java书上看到了类示例,并且private变量是JavaDoc的。所以我不明白JavaDocprivate(或protected)方法是否是一个好习惯。 最佳答案 是的,您应该为私有(private)方法编写JavaDoc,即