{"id":2183,"date":"2025-03-01T18:19:19","date_gmt":"2025-03-01T10:19:19","guid":{"rendered":"https:\/\/www.laixuexila.com\/?p=2183"},"modified":"2025-03-01T18:33:48","modified_gmt":"2025-03-01T10:33:48","slug":"javadoc-%e7%9a%84%e7%94%a8%e6%b3%95%e5%a6%82%e4%bd%95%e7%94%9f%e6%88%90-api-%e6%96%87%e6%a1%a3","status":"publish","type":"post","link":"https:\/\/www.laixuexila.com\/index.php\/2025\/03\/01\/javadoc-%e7%9a%84%e7%94%a8%e6%b3%95%e5%a6%82%e4%bd%95%e7%94%9f%e6%88%90-api-%e6%96%87%e6%a1%a3\/","title":{"rendered":"Javadoc \u7684\u7528\u6cd5&amp;\u5982\u4f55\u751f\u6210 API \u6587\u6863"},"content":{"rendered":"\n<p>Javadoc \u662f Java \u4e2d\u7528\u4e8e\u751f\u6210 API \u6587\u6863\u7684\u4e00\u79cd\u5de5\u5177\uff0c\u5b83\u901a\u8fc7\u7279\u6b8a\u683c\u5f0f\u7684\u6ce8\u91ca\uff08Javadoc \u6ce8\u91ca\uff09\u63d0\u53d6\u7c7b\u3001\u65b9\u6cd5\u3001\u5b57\u6bb5\u7b49\u7684\u4fe1\u606f\uff0c\u5e76\u751f\u6210 HTML \u683c\u5f0f\u7684\u6587\u6863\u3002\u8fd9\u4e9b\u6587\u6863\u53ef\u4ee5\u5e2e\u52a9\u5f00\u53d1\u8005\u4e86\u89e3\u7c7b\u7684\u7ed3\u6784\u3001\u529f\u80fd\u3001\u65b9\u6cd5\u7684\u53c2\u6570\u548c\u8fd4\u56de\u503c\u7b49\u4fe1\u606f\u3002\u7406\u89e3\u548c\u638c\u63e1 Javadoc \u7684\u4f7f\u7528\uff0c\u5bf9\u4e8e Java \u5f00\u53d1\u8005\u6765\u8bf4\u662f\u975e\u5e38\u91cd\u8981\u7684\u3002<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">1. <strong>Javadoc \u6ce8\u91ca\u683c\u5f0f<\/strong><\/h3>\n\n\n\n<p>Javadoc \u6ce8\u91ca\u5757\u4ee5 <code>\/**<\/code> \u5f00\u59cb\uff0c<code>*\/<\/code> \u7ed3\u675f\uff0c\u5e76\u4e14\u901a\u5e38\u4f4d\u4e8e\u7c7b\u3001\u65b9\u6cd5\u3001\u6784\u9020\u51fd\u6570\u548c\u5b57\u6bb5\u7684\u58f0\u660e\u524d\u3002\u5b83\u7684\u683c\u5f0f\u8981\u6c42\u5fc5\u987b\u5305\u62ec\u4e00\u4e9b\u7279\u5b9a\u7684\u6807\u7b7e\uff08tag\uff09\u6765\u63cf\u8ff0\u65b9\u6cd5\u548c\u7c7b\u7684\u884c\u4e3a\u3001\u53c2\u6570\u3001\u8fd4\u56de\u503c\u7b49\u3002<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\u57fa\u672c Javadoc \u6ce8\u91ca\u793a\u4f8b\uff1a<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * \u8fd9\u4e2a\u7c7b\u8868\u793a\u4e00\u4e2a\u7b80\u5355\u7684\u6c7d\u8f66\u5bf9\u8c61\u3002\n * \u5305\u542b\u6c7d\u8f66\u7684\u57fa\u672c\u4fe1\u606f\uff0c\u5e76\u63d0\u4f9b\u663e\u793a\u4fe1\u606f\u7684\u65b9\u6cd5\u3002\n *\/\npublic class Car {\n\n    \/**\n     * \u6c7d\u8f66\u7684\u54c1\u724c\n     *\/\n    String brand;\n\n    \/**\n     * \u6c7d\u8f66\u7684\u578b\u53f7\n     *\/\n    String model;\n\n    \/**\n     * \u6784\u9020\u51fd\u6570\uff1a\u521d\u59cb\u5316\u6c7d\u8f66\u7684\u54c1\u724c\u548c\u578b\u53f7\n     * \n     * @param brand \u6c7d\u8f66\u7684\u54c1\u724c\n     * @param model \u6c7d\u8f66\u7684\u578b\u53f7\n     *\/\n    public Car(String brand, String model) {\n        this.brand = brand;\n        this.model = model;\n    }\n\n    \/**\n     * \u663e\u793a\u6c7d\u8f66\u7684\u54c1\u724c\u548c\u578b\u53f7\n     *\/\n    public void displayInfo() {\n        System.out.println(\"Brand: \" + brand + \", Model: \" + model);\n    }\n}<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">2. <strong>\u5e38\u7528\u7684 Javadoc \u6807\u7b7e<\/strong><\/h3>\n\n\n\n<p>Javadoc \u4f7f\u7528\u4e00\u4e9b\u7279\u5b9a\u7684\u6807\u7b7e\u6765\u63cf\u8ff0\u7c7b\u3001\u65b9\u6cd5\u3001\u53c2\u6570\u548c\u8fd4\u56de\u503c\u7b49\u3002\u8fd9\u4e9b\u6807\u7b7e\u80fd\u591f\u4f7f\u751f\u6210\u7684\u6587\u6863\u66f4\u6e05\u6670\u548c\u6613\u4e8e\u7406\u89e3\u3002<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\u5e38\u7528\u6807\u7b7e\uff1a<\/h4>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong><code>@param<\/code><\/strong>\uff1a\u63cf\u8ff0\u65b9\u6cd5\u7684\u53c2\u6570\u3002<\/li>\n\n\n\n<li><strong><code>@return<\/code><\/strong>\uff1a\u63cf\u8ff0\u65b9\u6cd5\u7684\u8fd4\u56de\u503c\u3002<\/li>\n\n\n\n<li><strong><code>@throws<\/code><\/strong> \u6216 <strong><code>@exception<\/code><\/strong>\uff1a\u63cf\u8ff0\u65b9\u6cd5\u53ef\u80fd\u629b\u51fa\u7684\u5f02\u5e38\u3002<\/li>\n\n\n\n<li><strong><code>@see<\/code><\/strong>\uff1a\u63d0\u4f9b\u4e0e\u5f53\u524d\u7c7b\u6216\u65b9\u6cd5\u76f8\u5173\u7684\u5176\u4ed6\u7c7b\u6216\u65b9\u6cd5\u3002<\/li>\n\n\n\n<li><strong><code>@deprecated<\/code><\/strong>\uff1a\u6807\u8bb0\u5df2\u7ecf\u4e0d\u63a8\u8350\u4f7f\u7528\u7684\u65b9\u6cd5\u6216\u7c7b\u3002<\/li>\n\n\n\n<li><strong><code>@version<\/code><\/strong>\uff1a\u63cf\u8ff0\u7c7b\u7684\u7248\u672c\u3002<\/li>\n\n\n\n<li><strong><code>@author<\/code><\/strong>\uff1a\u6807\u6ce8\u7c7b\u7684\u4f5c\u8005\u3002<\/li>\n<\/ul>\n\n\n\n<h4 class=\"wp-block-heading\">\u793a\u4f8b\uff1a<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * \u8ba1\u7b97\u4e24\u4e2a\u6574\u6570\u7684\u548c\u3002\n *\n * @param a \u7b2c\u4e00\u4e2a\u6574\u6570\n * @param b \u7b2c\u4e8c\u4e2a\u6574\u6570\n * @return \u4e24\u4e2a\u6574\u6570\u7684\u548c\n * @throws IllegalArgumentException \u5982\u679c\u8f93\u5165\u7684\u53c2\u6570\u662f\u8d1f\u6570\n *\/\npublic int add(int a, int b) throws IllegalArgumentException {\n    if (a &lt; 0 || b &lt; 0) {\n        throw new IllegalArgumentException(\"\u53c2\u6570\u4e0d\u80fd\u662f\u8d1f\u6570\");\n    }\n    return a + b;\n}<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">3. <strong>\u751f\u6210 Javadoc \u6587\u6863<\/strong><\/h3>\n\n\n\n<p>Javadoc \u5de5\u5177\u5c06 Javadoc \u6ce8\u91ca\u8f6c\u6362\u4e3a HTML \u683c\u5f0f\u7684\u6587\u6863\uff0c\u5f00\u53d1\u4eba\u5458\u53ef\u4ee5\u8f7b\u677e\u6d4f\u89c8\u548c\u67e5\u770b API \u6587\u6863\u3002\u751f\u6210 Javadoc \u6587\u6863\u7684\u6b65\u9aa4\u5982\u4e0b\uff1a<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\u901a\u8fc7\u547d\u4ee4\u884c\u751f\u6210 Javadoc\uff1a<\/h4>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>\u4f7f\u7528 Javadoc \u547d\u4ee4<\/strong>\uff1a\u53ef\u4ee5\u901a\u8fc7 <code>javadoc<\/code> \u547d\u4ee4\u6765\u751f\u6210\u6587\u6863\u3002<\/li>\n<\/ol>\n\n\n\n<ul class=\"wp-block-list\">\n<li>\u6253\u5f00\u7ec8\u7aef\uff08\u547d\u4ee4\u884c\uff09\uff0c\u5e76\u8fdb\u5165 Java \u9879\u76ee\u7684\u6839\u76ee\u5f55\u3002<\/li>\n\n\n\n<li>\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u751f\u6210 Javadoc \u6587\u6863\uff1a<br><code>bash javadoc -d \u8f93\u51fa\u76ee\u5f55 -sourcepath \u6e90\u4ee3\u7801\u76ee\u5f55 \u7c7b\u6587\u4ef6\u6216\u5305<\/code><br>\u4f8b\u5982\uff0c\u5982\u679c\u4f60\u7684\u6e90\u4ee3\u7801\u4f4d\u4e8e <code>src<\/code> \u76ee\u5f55\uff0c\u5e76\u4e14\u4f60\u60f3\u5c06\u751f\u6210\u7684\u6587\u6863\u5b58\u50a8\u5728 <code>docs<\/code> \u76ee\u5f55\u4e0b\uff1a<br><code>bash javadoc -d docs -sourcepath src com.example.Car<\/code><br>\u8fd9\u5c06\u4e3a <code>com.example.Car<\/code> \u7c7b\u751f\u6210 HTML \u683c\u5f0f\u7684\u6587\u6863\uff0c\u5b58\u50a8\u5728 <code>docs<\/code> \u6587\u4ef6\u5939\u4e2d\u3002<\/li>\n<\/ul>\n\n\n\n<ol class=\"wp-block-list\">\n<li><strong>\u751f\u6210\u591a\u4e2a\u7c7b\u7684\u6587\u6863<\/strong>\uff1a\u4f60\u8fd8\u53ef\u4ee5\u751f\u6210\u591a\u4e2a\u7c7b\u6216\u6574\u4e2a\u5305\u7684\u6587\u6863\uff1a<\/li>\n<\/ol>\n\n\n\n<pre class=\"wp-block-code\"><code>   javadoc -d docs -sourcepath src com.example.*<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">\u5e38\u7528\u7684 Javadoc \u547d\u4ee4\u9009\u9879\uff1a<\/h4>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>-d &lt;\u76ee\u5f55><\/code>\uff1a\u6307\u5b9a\u751f\u6210\u7684\u6587\u6863\u8f93\u51fa\u76ee\u5f55\u3002<\/li>\n\n\n\n<li><code>-sourcepath &lt;\u76ee\u5f55><\/code>\uff1a\u6307\u5b9a\u6e90\u4ee3\u7801\u6587\u4ef6\u6240\u5728\u7684\u76ee\u5f55\u3002<\/li>\n\n\n\n<li><code>-subpackages &lt;\u5305\u540d><\/code>\uff1a\u751f\u6210\u5b50\u5305\u7684\u6587\u6863\u3002<\/li>\n\n\n\n<li><code>-author<\/code>\uff1a\u5305\u62ec <code>@author<\/code> \u6ce8\u91ca\u7684\u4fe1\u606f\u3002<\/li>\n\n\n\n<li><code>-version<\/code>\uff1a\u5305\u62ec <code>@version<\/code> \u6ce8\u91ca\u7684\u4fe1\u606f\u3002<\/li>\n<\/ul>\n\n\n\n<h4 class=\"wp-block-heading\">\u793a\u4f8b\uff1a<\/h4>\n\n\n\n<pre class=\"wp-block-code\"><code>javadoc -d docs -sourcepath src -author -version com.example.*<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\">4. <strong>\u67e5\u770b Javadoc \u6587\u6863<\/strong><\/h3>\n\n\n\n<p>\u751f\u6210\u7684 Javadoc \u6587\u6863\u4f1a\u5b58\u50a8\u4e3a HTML \u6587\u4ef6\u3002\u4f60\u53ef\u4ee5\u5728\u6d4f\u89c8\u5668\u4e2d\u6253\u5f00 <code>docs\/index.html<\/code> \u6587\u4ef6\uff0c\u67e5\u770b API \u6587\u6863\u3002<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>\u4e3b\u9875<\/strong>\uff1a\u4f1a\u5217\u51fa\u6240\u6709\u7684\u7c7b\u3001\u63a5\u53e3\u548c\u5305\u3002<\/li>\n\n\n\n<li><strong>\u7c7b\u6587\u6863<\/strong>\uff1a\u70b9\u51fb\u7c7b\u540d\uff0c\u67e5\u770b\u8be5\u7c7b\u7684\u8be6\u7ec6\u4fe1\u606f\uff0c\u5305\u62ec\u5b57\u6bb5\u3001\u65b9\u6cd5\u3001\u6784\u9020\u51fd\u6570\u3001\u7ee7\u627f\u5173\u7cfb\u7b49\u3002<\/li>\n\n\n\n<li><strong>\u65b9\u6cd5\u6587\u6863<\/strong>\uff1a\u70b9\u51fb\u65b9\u6cd5\u540d\uff0c\u67e5\u770b\u65b9\u6cd5\u7684\u63cf\u8ff0\u3001\u53c2\u6570\u3001\u8fd4\u56de\u503c\u3001\u53ef\u80fd\u629b\u51fa\u7684\u5f02\u5e38\u7b49\u3002<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">5. <strong>Javadoc \u5de5\u5177\u7684\u96c6\u6210\u5f00\u53d1\u73af\u5883\uff08IDE\uff09<\/strong><\/h3>\n\n\n\n<p>\u5927\u90e8\u5206\u73b0\u4ee3 IDE\uff08\u5982 IntelliJ IDEA\u3001Eclipse \u7b49\uff09\u90fd\u96c6\u6210\u4e86 Javadoc \u7684\u751f\u6210\u529f\u80fd\uff0c\u5141\u8bb8\u4f60\u76f4\u63a5\u5728 IDE \u4e2d\u751f\u6210 Javadoc \u6587\u6863\u3002\u8fd9\u4e9b IDE \u8fd8\u652f\u6301\u4e3a\u65b9\u6cd5\u548c\u7c7b\u81ea\u52a8\u751f\u6210 Javadoc \u6ce8\u91ca\u3002<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">\u5728 IntelliJ IDEA \u4e2d\u751f\u6210 Javadoc\uff1a<\/h4>\n\n\n\n<ol class=\"wp-block-list\">\n<li>\u6253\u5f00\u9879\u76ee\u3002<\/li>\n\n\n\n<li>\u9009\u62e9 <strong>Tools<\/strong> > <strong>Generate JavaDoc<\/strong>\u3002<\/li>\n\n\n\n<li>\u5728\u5f39\u51fa\u7684\u5bf9\u8bdd\u6846\u4e2d\uff0c\u9009\u62e9\u9700\u8981\u751f\u6210\u6587\u6863\u7684\u7c7b\u6216\u5305\uff0c\u8bbe\u7f6e\u8f93\u51fa\u76ee\u5f55\u3002<\/li>\n\n\n\n<li>\u70b9\u51fb <strong>OK<\/strong>\uff0c\u751f\u6210\u6587\u6863\u3002<\/li>\n<\/ol>\n\n\n\n<h4 class=\"wp-block-heading\">\u5728 Eclipse \u4e2d\u751f\u6210 Javadoc\uff1a<\/h4>\n\n\n\n<ol class=\"wp-block-list\">\n<li>\u6253\u5f00\u9879\u76ee\u3002<\/li>\n\n\n\n<li>\u9009\u62e9 <strong>Project<\/strong> > <strong>Generate Javadoc<\/strong>\u3002<\/li>\n\n\n\n<li>\u914d\u7f6e\u8f93\u51fa\u76ee\u5f55\u548c\u9009\u9879\uff0c\u70b9\u51fb <strong>Finish<\/strong>\uff0c\u751f\u6210\u6587\u6863\u3002<\/li>\n<\/ol>\n\n\n\n<h3 class=\"wp-block-heading\">6. <strong>Javadoc \u7684\u6700\u4f73\u5b9e\u8df5<\/strong><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>\u660e\u786e\u63cf\u8ff0<\/strong>\uff1a\u5728 Javadoc \u4e2d\uff0c\u5c3d\u91cf\u4f7f\u7528\u6e05\u6670\u3001\u7b80\u6d01\u7684\u8bed\u8a00\u63cf\u8ff0\u7c7b\u3001\u65b9\u6cd5\u548c\u53c2\u6570\u7684\u529f\u80fd\u548c\u884c\u4e3a\u3002<\/li>\n\n\n\n<li><strong>\u4fdd\u6301\u66f4\u65b0<\/strong>\uff1a\u6bcf\u6b21\u4fee\u6539\u4ee3\u7801\u65f6\uff0c\u8bb0\u5f97\u66f4\u65b0 Javadoc \u6ce8\u91ca\uff0c\u4ee5\u4fdd\u6301\u6587\u6863\u7684\u51c6\u786e\u6027\u3002<\/li>\n\n\n\n<li><strong>\u907f\u514d\u5197\u4f59<\/strong>\uff1a\u4e0d\u8981\u5728 Javadoc \u4e2d\u91cd\u590d\u4ee3\u7801\u7684\u5185\u5bb9\uff0c\u5c3d\u91cf\u4e13\u6ce8\u4e8e\u63cf\u8ff0\u7c7b\u548c\u65b9\u6cd5\u7684\u529f\u80fd\uff0c\u800c\u4e0d\u662f\u4ee3\u7801\u5b9e\u73b0\u3002<\/li>\n\n\n\n<li><strong>\u4f7f\u7528\u6807\u7b7e<\/strong>\uff1a\u9002\u5f53\u4f7f\u7528 <code>@param<\/code>\u3001<code>@return<\/code>\u3001<code>@throws<\/code> \u7b49\u6807\u7b7e\uff0c\u4ee5\u786e\u4fdd\u6587\u6863\u7684\u7ed3\u6784\u6e05\u6670\u3002<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">7. <strong>\u603b\u7ed3<\/strong><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Javadoc \u6ce8\u91ca\u662f\u4e3a Java \u7c7b\u548c\u65b9\u6cd5\u751f\u6210\u6587\u6863\u7684\u5de5\u5177\uff0c\u80fd\u591f\u5e2e\u52a9\u5f00\u53d1\u8005\u7406\u89e3\u7c7b\u7684\u7528\u9014\u3001\u65b9\u6cd5\u7684\u53c2\u6570\u548c\u8fd4\u56de\u503c\u7b49\u3002<\/li>\n\n\n\n<li>\u901a\u8fc7 <code>javadoc<\/code> \u547d\u4ee4\u6216 IDE \u96c6\u6210\u7684\u529f\u80fd\uff0c\u53ef\u4ee5\u8f7b\u677e\u751f\u6210 HTML \u683c\u5f0f\u7684 API \u6587\u6863\u3002<\/li>\n\n\n\n<li>Javadoc \u662f Java \u5f00\u53d1\u4e2d\u4e0d\u53ef\u6216\u7f3a\u7684\u5de5\u5177\uff0c\u5b83\u4e0d\u4ec5\u5e2e\u52a9\u56e2\u961f\u534f\u4f5c\uff0c\u4e5f\u80fd\u63d0\u9ad8\u4ee3\u7801\u7684\u53ef\u7ef4\u62a4\u6027\u3002<\/li>\n<\/ul>\n\n\n\n<p>\u66f4\u591a\u8be6\u7ec6\u5185\u5bb9\u8bf7\u5173\u6ce8\u5176\u4ed6\u76f8\u5173\u6587\u7ae0\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Javadoc \u662f Java \u4e2d\u7528\u4e8e\u751f\u6210 API \u6587\u6863\u7684\u4e00\u79cd\u5de5\u5177\uff0c\u5b83\u901a\u8fc7\u7279\u6b8a\u683c\u5f0f\u7684\u6ce8\u91ca\uff08Javadoc \u6ce8\u91ca\uff09 [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[68],"tags":[],"class_list":["post-2183","post","type-post","status-publish","format-standard","hentry","category-java"],"_links":{"self":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts\/2183","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/comments?post=2183"}],"version-history":[{"count":1,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts\/2183\/revisions"}],"predecessor-version":[{"id":2184,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts\/2183\/revisions\/2184"}],"wp:attachment":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/media?parent=2183"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/categories?post=2183"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/tags?post=2183"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}