java - @param Javadoc 内的代码片段

标签 java javadoc

是否可以将代码片段放入参数的 JavaDoc 中?我尝试了以下操作,但生成的文档中的代码片段未采用这种格式。

/**
 * Description of method
 *
 * @param dataSourceProperties defines the properties of this datasource. At a minimum, the following should
 * be provided
 *
 * <pre>
 * {@code
 *     String driverClassName = 'com.mysql.jdbc.Driver';
 *     String url = 'jdbc:mysql://localhost/example';
 *     String username = 'root';
 *     String password = 'password';
 * }
 * </pre>
 */

最佳答案

你就快到了。试试这个:

/**
 * Description of method
 *
 * @param dataSourceProperties defines the properties of this datasource. At a minimum, the following should
 * be provided
 *
 * <pre>
 * <code>
 *     String driverClassName = 'com.mysql.jdbc.Driver'
 *     String url = 'jdbc:mysql://localhost/example'
 *     String username = 'root'
 *     String password = 'password'
 * </code>
 * </pre>
 */

关于java - @param Javadoc 内的代码片段,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/24735958/

相关文章:

java - 通过 Hibernate 保存实体时出现 org.hibernate.WrongClassException

java - 如何让 TelegramBot 持续工作,而不需要一直手动启动我的 Java 程序?

java - 下载 JAVA JDK 6.0

java - 如何从 gradle javadoc 任务中排除生成的文件?

java - 混合 java/scala 项目的自动生成文档

android - 如何在 gradle javadoc 任务中设置指向外部 AndroidX 引用的链接?

java - 用 Java 编写一个 Unix Kill 程序

java - ViewPager 没有快速响应

java - 创建 Java 堆栈

java - 查找没有 Javadoc 的 Java 类、函数和成员