在一个Javadoc的param标签中放入多行的正确方法是什么？
在一个Javadoc的param标签中放入多行的正确方法是使用HTML的换行标签<br>。通过在每行的末尾添加<br>标签，可以实现多行文本的换行显示。
例如，假设我们有一个param标签如下所示：
@param name 参数名 参数描述如果我们想要在参数描述中添加多行内容，可以使用<br>标签进行换行，如下所示：
@param name 参数名 参数描述第一行<br>参数描述第二行<br>参数描述第三行这样，生成的文档中参数描述部分就会按照多行显示。
需要注意的是，Javadoc中支持使用HTML标签来格式化文本，但在使用时要确保标签的正确闭合，以避免影响整个文档的显示效果。
相关·内容
4回答
注释中的注释(看起来像什么)的目的是什么？例如，我在接口中的一个方法上面看到了下面的注释：
/**
* Create saved search
* REST: POST /lifecycles/savedsearches
* @param controlParameters control parameters
* @param search savedSearch object
* @throws ProcessingException if any processing exceptions
* @return Updated Object
*/
我理解注释的含义，只是想知道
浏览 3提问于2014-10-31得票数 3
回答已采纳
2回答
我正在使用这样的代码创建一个自定义的django模板标签：
@register.simple_tag(takes_context=True)
def render_listing(context, *args, **kwargs):
... my code ...
这很有效，但在我的模板中，似乎所有参数都必须在一行上，例如：
这是可行的：
{% render_listing param1=val1 param2=val2 ... paramN=valN %}
但在多行上，它不起作用：
{% render_listing param1=val1
par
浏览 19提问于2018-03-05得票数 22
回答已采纳
2回答
我有以下泛型类型的方法，但是当我运行maven checkstyle( maven -checkstyle-plugin，2.121)时，它在maven构建期间给了我Expected @param tag for '<T>'错误消息。我该怎么处理这件事呢？
/**
* Read in specified type of object from request body.
* @param request The HttpServletRequest
* @param expected The expected type T
* @return <T&g
浏览 0提问于2015-05-14得票数 13
回答已采纳
所有官方的JSDoc示例都有非常简单的文档字符串，如下所示：
/**
* @param {string} author - The author of the book.
*/
问题是，在实际的文档中，您通常有更长的文档字符串：
/**
* @param {string} author - The author of the book, presumably some person who writes well
*/
但由于大多数公司(出于合法的可读性原因)都有行长度限制，上述限制通常是不可接受的。然而，我不明白的是，应该用什么“正确”的方式来拆分这些行。
我可以这样做：
/**
浏览 4提问于2015-06-06得票数 60
回答已采纳
有没有一种方法可以让eclipse中的javadoc方法具有输入变量的类型？
我知道您可以使用变量名称作为标记，如下所示：
/*
* param1
* param2
*/
但我想要这样的东西：
/*
* String param1:
* int param2:
* return int:
*/
我已经在Window-->Preferences->Java-->Code Style-->Code Templates中看到了，但我看不到任何与我需要的标签相似的东西。
谢谢
浏览 4提问于2013-04-05得票数 1
我发现了一条规则，确保Javadoc对于公共方法的存在->“公共类型、方法和字段( public types，methods and fields，API)应该用Javadoc编写文档”，但是，它似乎无法验证param名称是否正确。例如，下面的JavaDoc应该会失败，因为'badName‘与'aParam’不匹配。我是否还可以使用另一条规则来验证JavaDoc的文档是否正确？
/**
* @param badName String
*/
public void myMethod(String aParam) {}
浏览 6提问于2018-01-10得票数 4
6回答
在Java中注释代码的最好方法是什么，有没有一种方法可以在Eclipse中自动生成函数名和参数？
例如，我正在手动编写这些评论：
// <summary>
// Some comments about the function
// </summary>
// <param name="id">the user ID</param>
// <param name="username">The user password</param>
// <returns></retur
浏览 0提问于2011-07-01得票数 2
回答已采纳
是否有一种方法可以调优DocLint (-Xdoclint)以允许javadocs中的新标记？现在我遇到了这样的错误：
error: unknown tag: checkstyle
* @checkstyle ParameterNumber (3 lines)
我在文档中找不到它，我想定义一个可以使用的标记列表(除了通常的@param、@return等)。
我不想完全禁用那些检查-我想要么添加新标签，要么只是禁用“未知标签”检查。
浏览 0提问于2018-04-27得票数 1
1回答
我正在开发一个Java类的程序，我们的教授给了我们下面的JavaDoc模板，用来记录每种方法。
/** *说明
* @param
*
* @precondition
*
* @postcondition / return
*
* @exception
*
* @note
*
**/
当我尝试为这个程序生成JavaDoc时，我只看到了描述、参数和异常。最重要的东西，@前置条件和@后置条件，不会出现。如果我能让@note也出现就好了。我尝试过在生成JavaDocs时通过将标签放在额外标签选项中来手动添加标签，但这不起作用。我正在开发Eclipse
浏览 0提问于2016-06-20得票数 1
在我们公司，有一条严格的规定，所有的东西都必须经过评论。这条规则有一些弱点，比如重复文本。为了避免重复注释，我想引用一个类成员的方法参数，但是找不到合适的解决方案。
当我链接方法参数中的类成员并悬停方法参数时，
/**
* I would like to see this comment
*/
private int lineNumber;
/**
* Creates a new {@link GroupByMetaData} object.
*
* @param aLineNumber {@link GroupByMetaData#li
浏览 7提问于2017-07-10得票数 1
回答已采纳
1回答
当使用vscode时，它帮助我编写get和set方法，并以以下格式自动填充它： /**
* @param strength the strength to set
*/
public void setStrength(int strength) {
this.strength = strength;
} 但是，如果我要写这篇文章，我会这样做： /**
* sets the strength variable
*/
public void setStrength(int newStrength)
浏览 10提问于2020-04-01得票数 0
回答已采纳
我刚刚开始在Java编程中使用IntelliJ思想，我看到了标记(它们被称为标记吗？)比如“param”和“param”。，这些标记的意义是什么?如果我的代码中没有这些标记， IntelliJ实际上会抱怨！
最重要的是什么，它们是用来做什么的？
我在IntelliJ文档中找不到有关这些标记的任何相关信息。
浏览 4提问于2011-10-09得票数 7
回答已采纳
Javascript中代码注释的正确方式是什么-语法与Java中的语法相同吗？哪些工具实际上会利用这些注释：
/*
* Add an element to the group
* @param {Object} overlayElement
* @param {Object} [element2] optional element
*/
我发现新的ReSharper6(我在VisualStudio 2010中编写JS )提供了与C#中相同的注释，但仅在函数体中，类似于/// <param name="overlayElement"></
浏览 1提问于2011-07-25得票数 12
回答已采纳
1回答
我想在160x170大小的盒子内添加标签(例如AnchorPane)。但是当文本对于它的容器来说太长时，溢出将被隐藏，而不是变成多行。我希望能够管理标签在Java代码和FXML的like I did with Web's CSS.codes都包括在内 我还试图改变标签的高度，宽度和填充，但它不起作用。
浏览 40提问于2019-09-02得票数 1
回答已采纳
我正在开发一个Tapestry组件库，并希望使用maven javadoc插件和Tapestry标签添加javadoc。
我在我的pom.xml中添加了以下内容：
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<ver
浏览 1提问于2014-05-13得票数 0
回答已采纳
1回答
从我的JSP文件中删除开关的正确方法是什么？我有一个工厂，可以返回多种类型的对象。它们中的每一个都有自己的表示逻辑，所以我需要这样的东西：
//From controller
@RequestMapping(value = "/source", method = RequestMethod.POST)
public ModelAndView doMainJob(@RequestParam("text") String text) {
ResultState state = new ResultStateFactory().fromString(text)
浏览 0提问于2013-02-28得票数 5
1回答
假设我有以下结构，valid用于验证每个验证器的自定义消息(特别是)。
type Login struct {
Email string `json:"email" valid:"required~Email is required,email~The email address provided is not valid"`
Password string `json:"password" valid:"required~Password is required,stringlength(6|40)~Password le
浏览 0提问于2018-08-23得票数 12
我试图使用JAVA内部的ELKI来运行DBSCAN。在测试中，我使用了一个FileBasedDatabaseConnection。现在我想使用我的自定义对象作为参数来运行DBSCAN。
我的对象有以下结构：
public class MyObject {
private Long id;
private Float param1;
private Float param2;
// ... and more parameters as well as getters and setters
}
我想使用List<MyObject>作为数据库在ELKI中运行DBSCAN
浏览 4提问于2015-06-17得票数 5
回答已采纳
如何将此注释从doxygen转换为javadoc？
/// <typeparam name="SolutionType">the custom solution data type, derived from <see cref="Solution{InputDataType}">Solution</see></typeparam>
我可以在javadoc中使用@param来代替typeparam。但是我不确定如何翻译see标签？
谢谢
浏览 0提问于2013-07-16得票数 0
1回答
我们使用Eclipse3.7开发Java We应用程序。目前，我们通过对每个Param使用@Param-注释来用参数注释所有Java方法。主要的优点是，我们在Eclipse中的javadoc视图中获得了所有方法参数的列表。我们现在喜欢删除所有这些@param javadoc注释，因为我们不需要它们(除了javadoc中的方法列表)。我的问题是，是否有一种方法可以获得方法中所有参数的列表，而不用@param注释该方法的每个参数？
浏览 4提问于2012-06-21得票数 0
我正在从链接中开发Spring Boot Javers integrations：，andProperty API已经被废弃了，它的替代品是什么？
@GetMapping("/audit")
public String getPersonChanges(@RequestParam Optional<String> param) {
QueryBuilder jqlQuery = QueryBuilder.byClass(Person.class);
jqlQuery = param.isPresent() ? jqlQuery
浏览 1提问于2019-07-31得票数 0
回答已采纳
我想使用代码清理来通过以下方式自动创建文档头：
/// <summary>
/// **Some summary.**
/// </summary>
/// <param name="myParam">**The param.**</param>
/// <typeparam name="TService">**The type.**</typeparam>
/// <returns>**Whatever.**</returns>
TService Do<TSe
浏览 1提问于2011-05-05得票数 2
通过这样做，我可以通过拥有多行@param来轻松地使用输入参数来完成这一任务：
#' @param var1 This is for x
#' @param var2 This is for y
#' @param var3 This is for Z
但是，对于返回的列表中的元素，如何做到这一点。我想包括每个元素的名称和关于它们的描述。将@return或@param链接在一起并不具有相同的行为。合适的标签是什么？
#' @return A list with the following elements:
#' @something element1
浏览 3提问于2016-01-29得票数 18
回答已采纳
1回答
我不知道为什么，但这已经是一个很长时间的问题了。
我似乎不能为我使用NetBeans 7.2的大多数应用程序生成Java Doc (7.1也有同样的问题)。我就是搞不明白为什么会出现这个错误：
java.lang.IllegalArgumentException: Error decoding percent encoded characters
我知道这个错误是什么意思(英语)，但我不知道为什么会这样。据我所知，在我的文档中不应该有任何“百分比编码字符”，除非我完全不知道这是什么意思。
下面是完整的代码(只有一个文件，而且它是一个接口，所以它相当简短)：
package access;
i
浏览 0提问于2012-11-26得票数 1
回答已采纳
我不想写多余的javadoc注释。正如您所看到的，@param x在某种程度上是多余的。是否有javadoc标记来设置从类@param x到类A中的@param x的引用，还是允许我忽略它？
/**
* Class A constructor
*
* @param x position on x-axis
*/
public A(final int x) {
this.x = x;
}
/**
* Class B constructor
*
* @param x position on x-axis
* @param y position on y-axis
浏览 3提问于2011-03-09得票数 11
回答已采纳
我记不起方法的顶部是什么，当您将鼠标放在方法上时会显示的部分，例如，servlet中doPost方法的默认顶部是：
/**
* Handles the HTTP <code>POST</code> method.
*
* @param request servlet request
* @param response servlet response
*
* @throws ServletException DOCUMENT ME!
* @throws IOException DOCUMENT ME!
*/
这个顶部部
浏览 0提问于2013-01-15得票数 1
回答已采纳
我有一个带有两个标签的TableView footerView，可以容纳多行。我在viewDidLayoutSubviews中使用了以下代码：
override func viewDidLayoutSubviews() {
super.viewDidLayoutSubviews()
label1.preferredMaxLayoutWidth = tableView.frame.size.width - Constant.footerMarginSpace
label2.preferredMaxLayoutWidth = tableView.frame.size.wid
浏览 0提问于2017-10-11得票数 0
我有一个带有getters和setter的构造函数的类，需要为它们创建一个javadoc。
当我创建javadoc时，getter和setter都有它们的注释，但是由于某种原因，构造函数没有出现在javadoc中。注意:我正在CMD中创建javadocs。我试过修改HTML版本，但还是什么都没有。
下面是这个类的样子：
/**
* PersonalDetails class
*
* <p>Details the general information of a person involved in Saint Louis
University
*/
public cl
浏览 0提问于2019-04-10得票数 1
回答已采纳
目前，我正在尝试通过ant脚本创建自定义的javadoc标签，以便在类级别的注释中声明一些属性。 我需要创建一个自定义标记，它类似于方法级别中的@param标记。这个标记可以在类级别中声明n次。 /**
* @argument name of the argument1: description1
* @argument name of the argument2: description2
*/
public class MainClass{
} 我期望生成的javadoc如下： Arguments:
name of the argument1: - description1
name o
浏览 51提问于2020-11-04得票数 0
回答已采纳
4回答
假设你有这样的签名：
public void MyFooBar(IExtraSuperLongTypeName param1, TypeA param2 ISomeotherReallyLongTypeName param3, TypeB param4, TypeC param5)
在一行中格式化很难看，而且很难读懂。resharper用来格式化的样式是将参数向下推，如下所示
public void MyFooBar(IExtraSuperLongTypeName param1, TypeA param2,
ISomeotherReallyLongTypeName param3, Ty
浏览 0提问于2016-08-19得票数 1
我想在一个方法的Javadoc注释中包含一个小代码示例。
/**
* -- ex: looping through List of Map objects --
* <code>
* for (int i = 0; i < list.size(); i++) {
* Map map = (Map)list.get(i);
* System.out.println(map.get("wordID"));
* System.out.println(map.get("word"));
* }
* &
浏览 1635提问于2017-12-19
1回答
我可以制作按钮，有多行，每行都有不同的样式吗？当我使用gtkmm时，我可以将小部件放在按钮中，这样我就可以用两个不同的样式标签制作vbox并将其放入按钮中。但是看起来好像我不能在qt的按钮中插入小工具。也许还有另一种方法，让每一行都有不同风格的多行按钮？ 对不起，我的英语！
浏览 14提问于2021-04-13得票数 0
回答已采纳
2回答
在Java for API文档中，我必须为构造函数编写param和return标签吗？
这是我的代码：
/**
* Another constructor for class Time1
*/
public Time1 (Time1 other)
{
_hour = other._hour; _minute = other._minute; _second = other._second;
}
浏览 3提问于2015-12-28得票数 7
回答已采纳
1回答
嗨，我在想@param标签是干什么用的？我读了一些关于其他各种堆栈溢出问题和java文档的文章，但仍然感到困惑。有人能用更简单的术语来解释它(我是一个初级程序员)吗？根据我的解释，它基本上告诉了方法接受的参数类型，这是正确的还是不正确的？谢谢!
浏览 2提问于2014-01-12得票数 0
回答已采纳
我正在尝试为我的项目创建一个github维基。但是我无法将Spring beans xml文件中的代码片段格式化到这个wiki中。正确的做法是什么？我尝试使用pre标签、code标签、多行代码标签等，但要么根本不显示，要么在同一行中显示所有内容。
浏览 0提问于2012-03-18得票数 103
回答已采纳
我收到以下检查样式错误 [ERROR] src\main\java\com\disney\wdpr\dclm\personalization\base\service\mapper\PaymentSvcMapper.java:[45,46] (javadoc) JavadocMethod: Expected @param tag for 'retrievePersonByPersonIdPayerResponse'.
[ERROR] src\main\java\com\disney\wdpr\dclm\personalization\base\service\mapper\P
浏览 182提问于2021-08-24得票数 1
回答已采纳
我有Maven项目
所有java文件都位于src/test/java中。
我的pom.xml在下面
<build>
<sourceDirectory>src</sourceDirectory>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-compiler-plug
浏览 2提问于2021-08-05得票数 1
回答已采纳
1回答
我知道这是一个简单的问题，但我不知怎么搞糊涂了。
如果我理解得很好，简而言之，当请求到达web服务器时，他会为某个servlet的每个请求创建线程。
考虑我们在MyServlet中的下一段代码(我省略了异常处理和类似的代码)：
synchronized protected void doGet( ... ...){
PrintWritet pw=response.getWriter();
String param=request.getParameter("p");
if(param.equals("a")){
wait
浏览 1提问于2011-05-22得票数 4
回答已采纳
我想要：
/**
* @param from a point belonging to the map
* @param to a point belonging to the map
* @return a list of weighted edges on the shortest path from
* {@code from} to {@code to}
*/
但是eclipse给了我：
/**
* @param from a point belonging to the map
* @param to a po
浏览 0提问于2011-12-02得票数 2
回答已采纳
在Eclipse中添加多行注释并对其进行格式化(Ctrl+Shift+F)时，它会自动在注释块内的每个新行的开头放置一个星号(*)。
/*
* this is my comment
*/
这种行为的原因是什么？
如何将其禁用？
浏览 0提问于2012-09-02得票数 20
回答已采纳
2回答
我在工作中一直在处理.jd文件，在本地计算机上构建它以将其转换为html...
然而，我仍然对.jd文件的用途感到困惑。我做了一些研究，其定义是："Javadoc是一种从代码中的Javadoc注释生成html文档(类似于java.sun.com的参考页面)的工具。“
当我查看.jd文件代码时，它们看起来非常像html。它们有<p>标签和<li>标签。程序员写javadoc代码吗？或者Javadoc是一个工具(这对我来说非常模糊，一个名为Javadoc的软件工具，用于生成.jd文件？)从Java代码中提取注释？
有人能帮我理解一下吗？因为我不是直接生成.jd文件，
浏览 0提问于2015-12-08得票数 2
Gradle javadoc选项(底部)多行：
task myJavadoc(type: Javadoc) {
...
options {
bottom """
<div>
Foo $version <br/>
© 2016-2017 All rights reserved.
"""
}
}
错误
javadoc: error - Il
浏览 1提问于2017-07-12得票数 0
我找不到任何关于在javadoc参数中有多行信息是否可以的信息。我正在制作一个国际象棋引擎，我希望能够解析一个字符串来生成一个棋盘。可以像我在下面做的那样吗？
/**
* Creates a board based on a string.
* @param boardString The string to be parsed. Must be of the format:
* "8x8\n" +
* "br,bn,bb,bq,bk,bb,bn,br\n" +
* "bp,bp,bp,bp,bp,bp,bp,bp
浏览 1提问于2016-09-10得票数 12
回答已采纳
3回答
jQuery &参数元素
、、、
这段代码正确吗？
$('<param><div></div></param>')
会产生这个输出吗？
[<param>, <div></div>]
而对于大多数其他标签(例如:section)
$('<section><div></div></section>')
产生
[<section>...</section>]
换句话说，jquery似乎删除了param元素中的元素，并将它们放在param元素旁边。我
浏览 1提问于2012-02-16得票数 1
回答已采纳
如何在Eclipse中自动生成基于xml的函数头注释(@param等)。Visual Studio中是否有等同于“/”的快捷方式。
浏览 0提问于2010-10-27得票数 21
回答已采纳
我有一个可读入文本文件的可可应用程序。我想在多行标签中显示该文本，但我无论如何也搞不清楚。我打开了我的.nib文件，弹出了一个多行标签，但之后我就卡住了。
我没有任何使用Xcode或Cocoa的经验，主要是Eclipse，Visual Studio，以及几乎所有其他IDE，除了Xcode，它看起来非常陌生。
浏览 0提问于2010-06-05得票数 2
回答已采纳
3回答
@param名称找不到
、、、
我正在尝试记录我的一个类，但是我一直收到同样的错误，我不明白为什么或者如何解决它。
以下是守则的有关部分：
/** Set the health.
@param health The health of the enemy */
public void setHealth(float health) {
this.health = maximum_health;
}
/** initialising */
public void initialise() {
setName("NONE");
}
浏览 5提问于2017-11-21得票数 2
回答已采纳
父视图是一个简单的UIView。父视图包含'n‘个标签。在我的例子中，父视图的宽度应该是具有最大宽度的标签的宽度，并且不超过最大宽度。如何为这种情况创建自动布局约束？
注:所有标签都是单行标签，没有多行。
浏览 7提问于2018-10-31得票数 0
4回答
我正在开发一个API，它有许多同名的方法，它们只是通过签名而不同，我想这是相当常见的。它们都执行相同的操作，只是在用户不想指定的情况下，它们以默认值初始化各种值。作为一个可理解的例子，请考虑
public interface Forest
{
public Tree addTree();
public Tree addTree(int amountOfLeaves);
public Tree addTree(int amountOfLeaves, Fruit fruitType);
public Tree addTree(int amountOfLeaves, int h
浏览 5提问于2010-04-01得票数 96
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
即时通信 IM
实时音视频活动推荐
腾讯云开发者
