Javadoc 中未显示文件
File not showing in Javadoc
我刚刚为项目中的一个文件制作了我的第一个 Javadoc。这个文件所在的包有 2 个文件,LoginInformation 文件和 DBRequests 文件。出于某种原因,当我打开 javadoc 时,所有文件都在那里,但上面有 Javadoc 注释的文件?
我的代码的结构方式是我有一大堆包,一些带有嵌套包,然后总共有大约 40 个文件。
只是想知道是否有人可以提供帮助,这是未显示的文件代码,以防万一我做错了什么:
package Database;
/**
* This class <b>LoginInformation</b> contains methods for retrieving the required
* login data for connection to the database
*
*/
abstract class LoginInformation {
/**
* URL of the database for connection
*/
private final static String URL = "jdbc:mysql://localhost:3306/sql_employees";
/**
* SQL root username for database connection
*/
private final static String USERNAME = "root";
/**
* Password of SQL root account for database connection
*/
private final static String PASSWORD = "";
/**
* Returns the URL used for connection
*
* @return URL of database
*/
public static String getURL() {
return URL;
}
/**
* Returns the username of the SQL account
*
* @return SQL account username
*/
public static String getUsername() {
return USERNAME;
}
/**
* Returns the password of the SQL account
*
* @return SQL account password
*/
public static String getPassword() {
return PASSWORD;
}
}
您的 class 具有默认的“程序包私有”可见性。默认情况下,Javadoc 会为 public 和受保护的访问级别 API 生成文档,但不会为“package private”或 private.
您可以使用 -package
命令行开关让 javadoc 生成此访问级别的文档。
如果您还想查看私有成员的文档,请使用 -private
另请参阅完整的工具文档:https://docs.oracle.com/javase/10/tools/javadoc.html
我刚刚为项目中的一个文件制作了我的第一个 Javadoc。这个文件所在的包有 2 个文件,LoginInformation 文件和 DBRequests 文件。出于某种原因,当我打开 javadoc 时,所有文件都在那里,但上面有 Javadoc 注释的文件?
我的代码的结构方式是我有一大堆包,一些带有嵌套包,然后总共有大约 40 个文件。
只是想知道是否有人可以提供帮助,这是未显示的文件代码,以防万一我做错了什么:
package Database;
/**
* This class <b>LoginInformation</b> contains methods for retrieving the required
* login data for connection to the database
*
*/
abstract class LoginInformation {
/**
* URL of the database for connection
*/
private final static String URL = "jdbc:mysql://localhost:3306/sql_employees";
/**
* SQL root username for database connection
*/
private final static String USERNAME = "root";
/**
* Password of SQL root account for database connection
*/
private final static String PASSWORD = "";
/**
* Returns the URL used for connection
*
* @return URL of database
*/
public static String getURL() {
return URL;
}
/**
* Returns the username of the SQL account
*
* @return SQL account username
*/
public static String getUsername() {
return USERNAME;
}
/**
* Returns the password of the SQL account
*
* @return SQL account password
*/
public static String getPassword() {
return PASSWORD;
}
}
您的 class 具有默认的“程序包私有”可见性。默认情况下,Javadoc 会为 public 和受保护的访问级别 API 生成文档,但不会为“package private”或 private.
您可以使用 -package
命令行开关让 javadoc 生成此访问级别的文档。
如果您还想查看私有成员的文档,请使用 -private
另请参阅完整的工具文档:https://docs.oracle.com/javase/10/tools/javadoc.html