{"id":2284,"date":"2025-03-03T23:26:40","date_gmt":"2025-03-03T15:26:40","guid":{"rendered":"https:\/\/www.laixuexila.com\/?p=2284"},"modified":"2025-03-03T23:26:40","modified_gmt":"2025-03-03T15:26:40","slug":"java-%e6%96%87%e6%a1%a3%e6%b3%a8%e9%87%8a","status":"publish","type":"post","link":"https:\/\/www.laixuexila.com\/index.php\/2025\/03\/03\/java-%e6%96%87%e6%a1%a3%e6%b3%a8%e9%87%8a\/","title":{"rendered":"Java \u6587\u6863\u6ce8\u91ca"},"content":{"rendered":"\n<p>Java \u6587\u6863\u6ce8\u91ca\uff08Javadoc\uff09\u662f Java \u7f16\u7a0b\u8bed\u8a00\u4e2d\u7684\u4e00\u79cd\u7279\u6b8a\u6ce8\u91ca\u683c\u5f0f\uff0c\u7528\u4e8e\u751f\u6210 API \u6587\u6863\u3002\u5b83\u4e0d\u4ec5\u53ef\u4ee5\u5e2e\u52a9\u5f00\u53d1\u4eba\u5458\u7406\u89e3\u4ee3\u7801\u7684\u4f5c\u7528\uff0c\u8fd8\u80fd\u4e3a\u5de5\u5177\u81ea\u52a8\u751f\u6210 HTML \u683c\u5f0f\u7684\u6587\u6863\u3002Javadoc \u6ce8\u91ca\u901a\u5e38\u7528\u4e8e\u7c7b\u3001\u65b9\u6cd5\u3001\u5b57\u6bb5\u7b49\u7684\u63cf\u8ff0\u3002<\/p>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>1. Javadoc \u6ce8\u91ca\u683c\u5f0f<\/strong><\/h3>\n\n\n\n<p>Javadoc \u6ce8\u91ca\u662f\u4ee5 <code>\/**<\/code> \u5f00\u59cb\uff0c<code>*\/<\/code> \u7ed3\u675f\uff0c\u901a\u5e38\u653e\u7f6e\u5728\u7c7b\u3001\u65b9\u6cd5\u6216\u5b57\u6bb5\u7684\u4e0a\u65b9\u3002<\/p>\n\n\n\n<p><strong>\u57fa\u672c\u683c\u5f0f\uff1a<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * \u8fd9\u662f\u7c7b\u7684\u63cf\u8ff0\n *\/\npublic class MyClass {\n    \/**\n     * \u8fd9\u662f\u5b57\u6bb5\u7684\u63cf\u8ff0\n     *\/\n    private int field;\n\n    \/**\n     * \u8fd9\u662f\u65b9\u6cd5\u7684\u63cf\u8ff0\n     * \n     * @param param \u8fd9\u662f\u65b9\u6cd5\u53c2\u6570\u7684\u63cf\u8ff0\n     * @return \u8fd4\u56de\u503c\u7684\u63cf\u8ff0\n     *\/\n    public int myMethod(int param) {\n        return param * 2;\n    }\n}<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>2. \u5e38\u7528 Javadoc \u6807\u7b7e<\/strong><\/h3>\n\n\n\n<p>Javadoc \u4f7f\u7528\u4e00\u4e9b\u7279\u6b8a\u7684\u6807\u7b7e\u6765\u5e2e\u52a9\u63cf\u8ff0\u4ee3\u7801\u7684\u4e0d\u540c\u90e8\u5206\u3002\u4ee5\u4e0b\u662f\u4e00\u4e9b\u5e38\u7528\u6807\u7b7e\uff1a<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>@param<\/strong>\uff1a\u63cf\u8ff0\u65b9\u6cd5\u7684\u53c2\u6570\u3002<\/li>\n\n\n\n<li><strong>@return<\/strong>\uff1a\u63cf\u8ff0\u65b9\u6cd5\u7684\u8fd4\u56de\u503c\u3002<\/li>\n\n\n\n<li><strong>@throws<\/strong> \u6216 <strong>@exception<\/strong>\uff1a\u63cf\u8ff0\u65b9\u6cd5\u53ef\u80fd\u629b\u51fa\u7684\u5f02\u5e38\u3002<\/li>\n\n\n\n<li><strong>@deprecated<\/strong>\uff1a\u6807\u8bb0\u8be5\u65b9\u6cd5\u6216\u7c7b\u5df2\u7ecf\u8fc7\u65f6\uff0c\u5efa\u8bae\u4f7f\u7528\u5176\u4ed6\u66ff\u4ee3\u65b9\u6cd5\u3002<\/li>\n\n\n\n<li><strong>@see<\/strong>\uff1a\u7528\u4e8e\u53c2\u8003\u5176\u4ed6\u7c7b\u3001\u65b9\u6cd5\u6216\u94fe\u63a5\u3002<\/li>\n\n\n\n<li><strong>@since<\/strong>\uff1a\u8868\u793a\u8be5\u65b9\u6cd5\u6216\u7c7b\u4ece\u54ea\u4e2a\u7248\u672c\u5f00\u59cb\u5f15\u5165\u3002<\/li>\n\n\n\n<li><strong>@author<\/strong>\uff1a\u6807\u8bb0\u7c7b\u6216\u65b9\u6cd5\u7684\u4f5c\u8005\u3002<\/li>\n\n\n\n<li><strong>@version<\/strong>\uff1a\u6807\u8bb0\u7c7b\u6216\u65b9\u6cd5\u7684\u7248\u672c\u3002<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>3. \u793a\u4f8b\uff1a<\/strong><\/h3>\n\n\n\n<pre class=\"wp-block-code\"><code>\/**\n * \u8fd9\u662f\u4e00\u4e2a\u7b80\u5355\u7684\u8ba1\u7b97\u5668\u7c7b\u3002\n * \u8be5\u7c7b\u63d0\u4f9b\u4e86\u52a0\u6cd5\u3001\u51cf\u6cd5\u3001\u4e58\u6cd5\u3001\u9664\u6cd5\u529f\u80fd\u3002\n * \n * @author YourName\n * @version 1.0\n * @since 2025-03-03\n *\/\npublic class Calculator {\n\n    \/**\n     * \u52a0\u6cd5\u64cd\u4f5c\n     * \n     * @param a \u7b2c\u4e00\u4e2a\u52a0\u6570\n     * @param b \u7b2c\u4e8c\u4e2a\u52a0\u6570\n     * @return \u4e24\u4e2a\u52a0\u6570\u7684\u548c\n     *\/\n    public int add(int a, int b) {\n        return a + b;\n    }\n\n    \/**\n     * \u9664\u6cd5\u64cd\u4f5c\n     * \n     * @param a \u88ab\u9664\u6570\n     * @param b \u9664\u6570\n     * @return \u5546\n     * @throws ArithmeticException \u5f53\u9664\u6570\u4e3a\u96f6\u65f6\u629b\u51fa\u8be5\u5f02\u5e38\n     *\/\n    public int divide(int a, int b) throws ArithmeticException {\n        if (b == 0) {\n            throw new ArithmeticException(\"\u9664\u6570\u4e0d\u80fd\u4e3a\u96f6\");\n        }\n        return a \/ b;\n    }\n\n    \/**\n     * \u7a0b\u5e8f\u5165\u53e3\n     * \n     * @param args \u547d\u4ee4\u884c\u53c2\u6570\n     *\/\n    public static void main(String&#91;] args) {\n        Calculator calculator = new Calculator();\n        System.out.println(\"\u52a0\u6cd5\u7ed3\u679c: \" + calculator.add(10, 5));\n        System.out.println(\"\u9664\u6cd5\u7ed3\u679c: \" + calculator.divide(10, 2));\n    }\n}<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>4. \u4f7f\u7528 Javadoc \u751f\u6210\u6587\u6863<\/strong><\/h3>\n\n\n\n<p>\u751f\u6210 Javadoc \u6587\u6863\u7684\u5de5\u5177\u662f JDK \u81ea\u5e26\u7684 <code>javadoc<\/code> \u547d\u4ee4\uff0c\u53ef\u4ee5\u4ece\u547d\u4ee4\u884c\u4f7f\u7528\u5b83\u6765\u751f\u6210 HTML \u683c\u5f0f\u7684 API \u6587\u6863\u3002<\/p>\n\n\n\n<p><strong>\u751f\u6210 Javadoc \u6587\u6863\u7684\u547d\u4ee4\uff1a<\/strong><\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>javadoc -d doc MyClass.java<\/code><\/pre>\n\n\n\n<ul class=\"wp-block-list\">\n<li><code>-d doc<\/code> \u53c2\u6570\u6307\u5b9a\u4e86\u6587\u6863\u8f93\u51fa\u7684\u76ee\u5f55\u3002<\/li>\n\n\n\n<li><code>MyClass.java<\/code> \u662f\u5305\u542b Javadoc \u6ce8\u91ca\u7684\u6e90\u4ee3\u7801\u6587\u4ef6\u3002<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>5. Javadoc \u7684\u91cd\u8981\u6027<\/strong><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>\u4ee3\u7801\u53ef\u7ef4\u62a4\u6027<\/strong>\uff1a\u6e05\u6670\u7684\u6587\u6863\u6ce8\u91ca\u5e2e\u52a9\u56e2\u961f\u6210\u5458\u7406\u89e3\u4ee3\u7801\u7684\u8bbe\u8ba1\u610f\u56fe\u3002<\/li>\n\n\n\n<li><strong>\u81ea\u52a8\u751f\u6210\u6587\u6863<\/strong>\uff1aJavadoc \u53ef\u4ee5\u901a\u8fc7\u5de5\u5177\u81ea\u52a8\u751f\u6210 HTML \u683c\u5f0f\u7684\u6587\u6863\uff0c\u65b9\u4fbf\u7528\u6237\u548c\u5f00\u53d1\u4eba\u5458\u67e5\u770b\u3002<\/li>\n\n\n\n<li><strong>\u63d0\u9ad8\u4ee3\u7801\u8d28\u91cf<\/strong>\uff1a\u597d\u7684\u6587\u6863\u6ce8\u91ca\u4f7f\u5f97\u4ee3\u7801\u66f4\u52a0\u6613\u4e8e\u4f7f\u7528\u3001\u7406\u89e3\u548c\u6269\u5c55\u3002<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\"><strong>6. \u6ce8\u610f\u4e8b\u9879<\/strong><\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>\u7b80\u6d01\u660e\u4e86<\/strong>\uff1a\u6587\u6863\u6ce8\u91ca\u5e94\u7b80\u6d01\u3001\u6e05\u6670\u3001\u7cbe\u786e\u5730\u63cf\u8ff0\u4ee3\u7801\u529f\u80fd\u3002<\/li>\n\n\n\n<li><strong>\u53ca\u65f6\u66f4\u65b0<\/strong>\uff1a\u6587\u6863\u6ce8\u91ca\u5e94\u968f\u4ee3\u7801\u66f4\u65b0\u800c\u66f4\u65b0\uff0c\u786e\u4fdd\u5176\u4e0e\u5b9e\u73b0\u4e00\u81f4\u3002<\/li>\n\n\n\n<li><strong>\u907f\u514d\u8fc7\u5ea6\u6ce8\u91ca<\/strong>\uff1a\u4ee3\u7801\u672c\u8eab\u5e94\u8be5\u5c3d\u91cf\u6e05\u6670\uff0c\u6ce8\u91ca\u5e94\u63d0\u4f9b\u9644\u52a0\u7684\u3001\u6709\u4ef7\u503c\u7684\u4fe1\u606f\u3002<\/li>\n<\/ul>\n\n\n\n<p>Javadoc \u662f Java \u4e2d\u975e\u5e38\u91cd\u8981\u7684\u5de5\u5177\uff0c\u5b83\u5e2e\u52a9\u5f00\u53d1\u4eba\u5458\u751f\u6210\u6e05\u6670\u3001\u7ed3\u6784\u5316\u7684 API \u6587\u6863\uff0c\u4fbf\u4e8e\u56e2\u961f\u5f00\u53d1\u4e0e\u7ef4\u62a4\u3002\u4f60\u53ef\u4ee5\u901a\u8fc7\u7f16\u5199\u5408\u9002\u7684 Javadoc \u6ce8\u91ca\uff0c\u4f7f\u4f60\u7684\u4ee3\u7801\u66f4\u52a0\u89c4\u8303\u548c\u6613\u4e8e\u7406\u89e3\u3002\u66f4\u591a\u8be6\u7ec6\u5185\u5bb9\u8bf7\u5173\u6ce8\u5176\u4ed6\u76f8\u5173\u6587\u7ae0\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Java \u6587\u6863\u6ce8\u91ca\uff08Javadoc\uff09\u662f Java \u7f16\u7a0b\u8bed\u8a00\u4e2d\u7684\u4e00\u79cd\u7279\u6b8a\u6ce8\u91ca\u683c\u5f0f\uff0c\u7528\u4e8e\u751f\u6210 API \u6587\u6863\u3002\u5b83\u4e0d\u4ec5 [&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-2284","post","type-post","status-publish","format-standard","hentry","category-java"],"_links":{"self":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts\/2284","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=2284"}],"version-history":[{"count":1,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts\/2284\/revisions"}],"predecessor-version":[{"id":2285,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/posts\/2284\/revisions\/2285"}],"wp:attachment":[{"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/media?parent=2284"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/categories?post=2284"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.laixuexila.com\/index.php\/wp-json\/wp\/v2\/tags?post=2284"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}