{"id":763398,"date":"2024-07-25T19:57:18","date_gmt":"2024-07-25T11:57:18","guid":{"rendered":"https:\/\/docs.pingcode.com\/ask\/ask-ask\/763398.html"},"modified":"2024-07-25T19:57:21","modified_gmt":"2024-07-25T11:57:21","slug":"%e7%a0%94%e5%8f%91%e4%bb%a3%e7%a0%81%e6%b3%a8%e9%87%8a%e8%bd%af%e4%bb%b6%e6%9c%89%e5%93%aa%e4%ba%9b","status":"publish","type":"post","link":"https:\/\/docs.pingcode.com\/ask\/763398.html","title":{"rendered":"\u7814\u53d1\u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\u6709\u54ea\u4e9b"},"content":{"rendered":"<p style=\"text-align:center\"><img decoding=\"async\" src=\"https:\/\/cdn-kb.worktile.com\/kb\/wp-content\/uploads\/2024\/04\/25084517\/d17586d5-7be5-4b70-9bd2-423dc29e1940.webp\" alt=\"\u7814\u53d1\u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\u6709\u54ea\u4e9b\" \/><\/p>\n<p><p><strong>\u7814\u53d1\u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\u6709\u54ea\u4e9b\uff1f<\/strong> \u4e3b\u8981\u6709<strong>Doxygen\u3001Javadoc\u3001Pydoc\u3001Sphinx\u3001DocFX<\/strong>\u7b49\u3002 \u5176\u4e2d\uff0cDoxygen\u662f\u6700\u53d7\u6b22\u8fce\u548c\u529f\u80fd\u6700\u5168\u9762\u7684\uff0c\u5b83\u652f\u6301\u591a\u79cd\u7f16\u7a0b\u8bed\u8a00\uff0c\u5e76\u4e14\u53ef\u4ee5\u751f\u6210\u5404\u79cd\u683c\u5f0f\u7684\u6587\u6863\uff0c\u5305\u62ecHTML\u3001LaTeX\u3001CHM\u548cRTF\u7b49\u3002<\/p>\n<\/p>\n<hr>\n<h2><strong>\u4e00\u3001Doxygen<\/strong><\/h2>\n<p><p>Doxygen \u662f\u4e00\u4e2a\u5f00\u6e90\u7684\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u5e7f\u6cdb\u7528\u4e8e\u4e3aC++\u3001C\u3001Java\u3001Objective-C\u3001Python\u548c\u5176\u4ed6\u7f16\u7a0b\u8bed\u8a00\u7684\u4ee3\u7801\u751f\u6210\u6587\u6863\u3002\u5b83\u53ef\u4ee5\u901a\u8fc7\u8bfb\u53d6\u4ee3\u7801\u4e2d\u7684\u6ce8\u91ca\u751f\u6210\u5168\u9762\u7684\u6587\u6863\uff0c\u652f\u6301\u591a\u79cd\u8f93\u51fa\u683c\u5f0f\u3002<\/p>\n<\/p>\n<p><h2>1.1 \u529f\u80fd\u7279\u70b9<\/h2>\n<\/p>\n<p><p>Doxygen \u6700\u663e\u8457\u7684\u7279\u70b9\u662f\u5176\u591a\u8bed\u8a00\u652f\u6301\u548c\u591a\u683c\u5f0f\u8f93\u51fa\u3002<strong>\u5b83\u4e0d\u4ec5\u652f\u6301C++\uff0c\u8fd8\u652f\u6301C\u3001Java\u3001Objective-C\u3001Python\u3001IDL\u3001Fortran\u3001VHDL\u3001PHP\u3001C#\u7b49\u8bed\u8a00<\/strong>\u3002\u6b64\u5916\uff0cDoxygen \u53ef\u4ee5\u751f\u6210\u591a\u79cd\u683c\u5f0f\u7684\u6587\u6863\uff0c\u5982HTML\u3001LaTeX\u3001CHM\u3001RTF\u7b49\uff0c\u65b9\u4fbf\u4e0d\u540c\u7528\u6237\u7684\u9700\u6c42\u3002<\/p>\n<\/p>\n<p><p>Doxygen \u7684\u53e6\u4e00\u4e2a\u4f18\u52bf\u662f\u5176\u7075\u6d3b\u6027\u548c\u53ef\u6269\u5c55\u6027\u3002\u7528\u6237\u53ef\u4ee5\u901a\u8fc7\u914d\u7f6e\u6587\u4ef6\u81ea\u5b9a\u4e49\u751f\u6210\u7684\u6587\u6863\u683c\u5f0f\u548c\u5185\u5bb9\u3002\u6b64\u5916\uff0cDoxygen \u8fd8\u652f\u6301\u56fe\u5f62\u5316\u8868\u793a\u4ee3\u7801\u7ed3\u6784\uff0c\u751f\u6210\u7c7b\u56fe\u3001\u8c03\u7528\u56fe\u7b49\uff0c\u4f7f\u5f97\u6587\u6863\u66f4\u52a0\u76f4\u89c2\u3002<\/p>\n<\/p>\n<p><h2>1.2 \u4f7f\u7528\u65b9\u6cd5<\/h2>\n<\/p>\n<p><p>\u4f7f\u7528 Doxygen \u7684\u7b2c\u4e00\u6b65\u662f\u7f16\u5199\u6ce8\u91ca\u3002Doxygen \u4f7f\u7528\u7279\u6b8a\u7684\u6ce8\u91ca\u683c\u5f0f\uff0c\u4f8b\u5982\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-cpp\">\/<\/p>\n<p> * \\brief This is a brief description.<\/p>\n<p> * <\/p>\n<p> * This is a det<a href=\"https:\/\/docs.pingcode.com\/blog\/59162.html\" target=\"_blank\">AI<\/a>led description.<\/p>\n<p> * <\/p>\n<p> * \\param param1 Description of the parameter.<\/p>\n<p> * \\return Description of the return value.<\/p>\n<p> *\/<\/p>\n<p>int exampleFunction(int param1);<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u63a5\u4e0b\u6765\uff0c\u7528\u6237\u9700\u8981\u521b\u5efa\u4e00\u4e2aDoxygen\u914d\u7f6e\u6587\u4ef6\uff0c\u53ef\u4ee5\u901a\u8fc7\u4ee5\u4e0b\u547d\u4ee4\u751f\u6210\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">doxygen -g<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u7136\u540e\uff0c\u7528\u6237\u53ef\u4ee5\u7f16\u8f91\u751f\u6210\u7684\u914d\u7f6e\u6587\u4ef6\uff0c\u8bbe\u7f6e\u5404\u79cd\u9009\u9879\uff0c\u5982\u8f93\u5165\u6587\u4ef6\u3001\u8f93\u51fa\u683c\u5f0f\u7b49\u3002\u6700\u540e\uff0c\u8fd0\u884cDoxygen\u547d\u4ee4\u751f\u6210\u6587\u6863\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">doxygen Doxyfile<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><h2>1.3 \u5b9e\u9645\u5e94\u7528<\/h2>\n<\/p>\n<p><p>\u5728\u5b9e\u9645\u9879\u76ee\u4e2d\uff0cDoxygen \u5e38\u7528\u4e8e\u751f\u6210 API \u6587\u6863\u3002\u5b83\u53ef\u4ee5\u8bfb\u53d6\u4ee3\u7801\u4e2d\u7684\u6ce8\u91ca\uff0c\u751f\u6210\u8be6\u7ec6\u7684\u51fd\u6570\u3001\u7c7b\u3001\u6a21\u5757\u7b49\u6587\u6863\uff0c\u65b9\u4fbf\u5f00\u53d1\u8005\u4e86\u89e3\u548c\u4f7f\u7528 API\u3002\u6b64\u5916\uff0cDoxygen \u8fd8\u652f\u6301\u751f\u6210\u56fe\u5f62\u5316\u8868\u793a\u4ee3\u7801\u7ed3\u6784\u7684\u56fe\u8868\uff0c\u5e2e\u52a9\u5f00\u53d1\u8005\u7406\u89e3\u4ee3\u7801\u7684\u6574\u4f53\u67b6\u6784\u3002<\/p>\n<\/p>\n<p><p>\u5bf9\u4e8e\u5927\u578b\u9879\u76ee\uff0cDoxygen \u7684\u591a\u8bed\u8a00\u652f\u6301\u548c\u591a\u683c\u5f0f\u8f93\u51fa\u529f\u80fd\u5c24\u4e3a\u91cd\u8981\u3002\u5f00\u53d1\u56e2\u961f\u53ef\u4ee5\u4f7f\u7528Doxygen \u4e3a\u4e0d\u540c\u8bed\u8a00\u7684\u4ee3\u7801\u751f\u6210\u7edf\u4e00\u7684\u6587\u6863\uff0c\u5e76\u5bfc\u51fa\u4e3aHTML\u3001PDF\u7b49\u683c\u5f0f\uff0c\u65b9\u4fbf\u4e0d\u540c\u7528\u6237\u67e5\u9605\u3002<\/p>\n<\/p>\n<h2><strong>\u4e8c\u3001Javadoc<\/strong><\/h2>\n<p><p>Javadoc \u662fJava\u8bed\u8a00\u7684\u5b98\u65b9\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u53ef\u4ee5\u901a\u8fc7\u8bfb\u53d6Java\u4ee3\u7801\u4e2d\u7684\u6ce8\u91ca\u751f\u6210\u6807\u51c6\u7684API\u6587\u6863\u3002\u5b83\u662fJava\u5f00\u53d1\u4e2d\u4e0d\u53ef\u6216\u7f3a\u7684\u5de5\u5177\u3002<\/p>\n<\/p>\n<p><h2>2.1 \u529f\u80fd\u7279\u70b9<\/h2>\n<\/p>\n<p><p>Javadoc \u4e13\u4e3aJava\u8bbe\u8ba1\uff0c\u80fd\u591f\u751f\u6210\u6807\u51c6\u7684Java API\u6587\u6863\u3002<strong>\u5b83\u652f\u6301HTML\u683c\u5f0f\u8f93\u51fa\uff0c\u751f\u6210\u7684\u6587\u6863\u5305\u542b\u7c7b\u3001\u63a5\u53e3\u3001\u65b9\u6cd5\u3001\u5b57\u6bb5\u7b49\u8be6\u7ec6\u4fe1\u606f<\/strong>\u3002\u6b64\u5916\uff0cJavadoc \u8fd8\u652f\u6301\u94fe\u63a5\u5176\u4ed6Javadoc\u6587\u6863\uff0c\u65b9\u4fbf\u5f00\u53d1\u8005\u5728\u4e0d\u540c\u9879\u76ee\u4e4b\u95f4\u8df3\u8f6c\u3002<\/p>\n<\/p>\n<p><p>Javadoc \u7684\u6ce8\u91ca\u683c\u5f0f\u7b80\u5355\u660e\u4e86\uff0c\u4f7f\u7528\u7279\u6b8a\u7684\u6807\u7b7e\uff0c\u5982 <code>@param<\/code>\u3001<code>@return<\/code>\u3001<code>@see<\/code> \u7b49\uff0c\u4fbf\u4e8e\u5f00\u53d1\u8005\u7f16\u5199\u548c\u9605\u8bfb\u6ce8\u91ca\u3002Javadoc \u751f\u6210\u7684\u6587\u6863\u7ed3\u6784\u6e05\u6670\uff0c\u5305\u542b\u7d22\u5f15\u3001\u6982\u8ff0\u3001\u8be6\u7ec6\u63cf\u8ff0\u7b49\u90e8\u5206\uff0c\u65b9\u4fbf\u7528\u6237\u67e5\u9605\u3002<\/p>\n<\/p>\n<p><h2>2.2 \u4f7f\u7528\u65b9\u6cd5<\/h2>\n<\/p>\n<p><p>\u4f7f\u7528 Javadoc \u7684\u7b2c\u4e00\u6b65\u662f\u7f16\u5199\u6ce8\u91ca\u3002Javadoc \u4f7f\u7528\u7279\u6b8a\u7684\u6ce8\u91ca\u683c\u5f0f\uff0c\u4f8b\u5982\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-java\">\/<\/p>\n<p> * This is a brief description.<\/p>\n<p> * <\/p>\n<p> * @param param1 Description of the parameter.<\/p>\n<p> * @return Description of the return value.<\/p>\n<p> *\/<\/p>\n<p>public int exampleMethod(int param1) {<\/p>\n<p>    \/\/ method body<\/p>\n<p>}<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u63a5\u4e0b\u6765\uff0c\u7528\u6237\u53ef\u4ee5\u4f7f\u7528Javadoc\u547d\u4ee4\u751f\u6210\u6587\u6863\u3002\u4f8b\u5982\uff0c\u8981\u4e3a <code>src<\/code> \u76ee\u5f55\u4e0b\u7684\u6240\u6709Java\u6587\u4ef6\u751f\u6210\u6587\u6863\uff0c\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">javadoc -d doc src\/*.java<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><h2>2.3 \u5b9e\u9645\u5e94\u7528<\/h2>\n<\/p>\n<p><p>\u5728Java\u5f00\u53d1\u4e2d\uff0cJavadoc \u662f\u751f\u6210API\u6587\u6863\u7684\u6807\u51c6\u5de5\u5177\u3002\u5f00\u53d1\u56e2\u961f\u53ef\u4ee5\u4f7f\u7528Javadoc \u4e3a\u9879\u76ee\u751f\u6210\u8be6\u7ec6\u7684API\u6587\u6863\uff0c\u5305\u542b\u7c7b\u3001\u63a5\u53e3\u3001\u65b9\u6cd5\u3001\u5b57\u6bb5\u7b49\u4fe1\u606f\uff0c\u65b9\u4fbf\u5f00\u53d1\u8005\u67e5\u9605\u548c\u4f7f\u7528API\u3002<\/p>\n<\/p>\n<p><p>\u6b64\u5916\uff0cJavadoc \u8fd8\u5e38\u7528\u4e8e\u751f\u6210\u5e93\u548c\u6846\u67b6\u7684\u6587\u6863\u3002\u901a\u8fc7\u7f16\u5199\u8be6\u7ec6\u7684\u6ce8\u91ca\uff0c\u5f00\u53d1\u8005\u53ef\u4ee5\u4f7f\u7528Javadoc \u751f\u6210\u6807\u51c6\u7684API\u6587\u6863\uff0c\u5e2e\u52a9\u7528\u6237\u4e86\u89e3\u548c\u4f7f\u7528\u5e93\u548c\u6846\u67b6\u7684\u529f\u80fd\u3002<\/p>\n<\/p>\n<h2><strong>\u4e09\u3001Pydoc<\/strong><\/h2>\n<p><p>Pydoc \u662fPython\u7684\u5b98\u65b9\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u53ef\u4ee5\u901a\u8fc7\u8bfb\u53d6Python\u4ee3\u7801\u4e2d\u7684\u6ce8\u91ca\u751f\u6210\u6587\u6863\u3002\u5b83\u662fPython\u5f00\u53d1\u4e2d\u5e38\u7528\u7684\u5de5\u5177\u4e4b\u4e00\u3002<\/p>\n<\/p>\n<p><h2>3.1 \u529f\u80fd\u7279\u70b9<\/h2>\n<\/p>\n<p><p>Pydoc \u4e13\u4e3aPython\u8bbe\u8ba1\uff0c\u80fd\u591f\u751f\u6210\u8be6\u7ec6\u7684Python API\u6587\u6863\u3002<strong>\u5b83\u652f\u6301HTML\u548c\u7eaf\u6587\u672c\u683c\u5f0f\u8f93\u51fa\uff0c\u751f\u6210\u7684\u6587\u6863\u5305\u542b\u6a21\u5757\u3001\u7c7b\u3001\u51fd\u6570\u3001\u65b9\u6cd5\u7b49\u8be6\u7ec6\u4fe1\u606f<\/strong>\u3002\u6b64\u5916\uff0cPydoc \u8fd8\u652f\u6301\u5728\u547d\u4ee4\u884c\u4e2d\u67e5\u770b\u6587\u6863\uff0c\u65b9\u4fbf\u5f00\u53d1\u8005\u5feb\u901f\u67e5\u9605\u3002<\/p>\n<\/p>\n<p><p>Pydoc \u7684\u6ce8\u91ca\u683c\u5f0f\u7b80\u5355\u660e\u4e86\uff0c\u4f7f\u7528\u6807\u51c6\u7684Python\u6ce8\u91ca\u683c\u5f0f\uff0c\u4fbf\u4e8e\u5f00\u53d1\u8005\u7f16\u5199\u548c\u9605\u8bfb\u6ce8\u91ca\u3002Pydoc \u751f\u6210\u7684\u6587\u6863\u7ed3\u6784\u6e05\u6670\uff0c\u5305\u542b\u6982\u8ff0\u3001\u8be6\u7ec6\u63cf\u8ff0\u7b49\u90e8\u5206\uff0c\u65b9\u4fbf\u7528\u6237\u67e5\u9605\u3002<\/p>\n<\/p>\n<p><h2>3.2 \u4f7f\u7528\u65b9\u6cd5<\/h2>\n<\/p>\n<p><p>\u4f7f\u7528 Pydoc \u7684\u7b2c\u4e00\u6b65\u662f\u7f16\u5199\u6ce8\u91ca\u3002Pydoc \u4f7f\u7528\u6807\u51c6\u7684Python\u6ce8\u91ca\u683c\u5f0f\uff0c\u4f8b\u5982\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-python\">def example_function(param1):<\/p>\n<p>    &quot;&quot;&quot;<\/p>\n<p>    This is a brief description.<\/p>\n<p>    :param param1: Description of the parameter.<\/p>\n<p>    :return: Description of the return value.<\/p>\n<p>    &quot;&quot;&quot;<\/p>\n<p>    # function body<\/p>\n<p>    return param1<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u63a5\u4e0b\u6765\uff0c\u7528\u6237\u53ef\u4ee5\u4f7f\u7528Pydoc\u547d\u4ee4\u751f\u6210\u6587\u6863\u3002\u4f8b\u5982\uff0c\u8981\u4e3a <code>example.py<\/code> \u6587\u4ef6\u751f\u6210HTML\u6587\u6863\uff0c\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">pydoc -w example<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><h2>3.3 \u5b9e\u9645\u5e94\u7528<\/h2>\n<\/p>\n<p><p>\u5728Python\u5f00\u53d1\u4e2d\uff0cPydoc \u662f\u751f\u6210API\u6587\u6863\u7684\u5e38\u7528\u5de5\u5177\u3002\u5f00\u53d1\u56e2\u961f\u53ef\u4ee5\u4f7f\u7528Pydoc \u4e3a\u9879\u76ee\u751f\u6210\u8be6\u7ec6\u7684API\u6587\u6863\uff0c\u5305\u542b\u6a21\u5757\u3001\u7c7b\u3001\u51fd\u6570\u3001\u65b9\u6cd5\u7b49\u4fe1\u606f\uff0c\u65b9\u4fbf\u5f00\u53d1\u8005\u67e5\u9605\u548c\u4f7f\u7528API\u3002<\/p>\n<\/p>\n<p><p>\u6b64\u5916\uff0cPydoc \u8fd8\u5e38\u7528\u4e8e\u751f\u6210\u5e93\u548c\u6846\u67b6\u7684\u6587\u6863\u3002\u901a\u8fc7\u7f16\u5199\u8be6\u7ec6\u7684\u6ce8\u91ca\uff0c\u5f00\u53d1\u8005\u53ef\u4ee5\u4f7f\u7528Pydoc \u751f\u6210\u6807\u51c6\u7684API\u6587\u6863\uff0c\u5e2e\u52a9\u7528\u6237\u4e86\u89e3\u548c\u4f7f\u7528\u5e93\u548c\u6846\u67b6\u7684\u529f\u80fd\u3002<\/p>\n<\/p>\n<h2><strong>\u56db\u3001Sphinx<\/strong><\/h2>\n<p><p>Sphinx \u662f\u4e00\u4e2a\u5f3a\u5927\u7684\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u5e7f\u6cdb\u7528\u4e8e\u751f\u6210Python\u9879\u76ee\u7684\u6587\u6863\u3002\u5b83\u652f\u6301\u591a\u79cd\u8f93\u51fa\u683c\u5f0f\uff0c\u5e76\u4e14\u53ef\u4ee5\u901a\u8fc7\u6269\u5c55\u63d2\u4ef6\u589e\u52a0\u529f\u80fd\u3002<\/p>\n<\/p>\n<p><h2>4.1 \u529f\u80fd\u7279\u70b9<\/h2>\n<\/p>\n<p><p>Sphinx \u6700\u663e\u8457\u7684\u7279\u70b9\u662f\u5176\u7075\u6d3b\u6027\u548c\u53ef\u6269\u5c55\u6027\u3002<strong>\u5b83\u4e0d\u4ec5\u652f\u6301\u751f\u6210HTML\u3001LaTeX\u3001EPUB\u3001Man Page\u7b49\u591a\u79cd\u683c\u5f0f\u7684\u6587\u6863\uff0c\u8fd8\u652f\u6301\u901a\u8fc7\u6269\u5c55\u63d2\u4ef6\u589e\u52a0\u529f\u80fd<\/strong>\u3002\u4f8b\u5982\uff0c\u4f7f\u7528 <code>sphinx.ext.autodoc<\/code> \u6269\u5c55\uff0cSphinx \u53ef\u4ee5\u4ece\u4ee3\u7801\u4e2d\u7684\u6ce8\u91ca\u81ea\u52a8\u751f\u6210API\u6587\u6863\u3002<\/p>\n<\/p>\n<p><p>Sphinx \u4f7f\u7528reStructuredText\uff08reST\uff09\u4f5c\u4e3a\u6587\u6863\u7f16\u5199\u683c\u5f0f\uff0c\u4fbf\u4e8e\u7f16\u5199\u548c\u9605\u8bfb\u3002Sphinx \u751f\u6210\u7684\u6587\u6863\u7ed3\u6784\u6e05\u6670\uff0c\u5305\u542b\u7d22\u5f15\u3001\u6982\u8ff0\u3001\u8be6\u7ec6\u63cf\u8ff0\u7b49\u90e8\u5206\uff0c\u65b9\u4fbf\u7528\u6237\u67e5\u9605\u3002\u6b64\u5916\uff0cSphinx \u8fd8\u652f\u6301\u751f\u6210\u56fe\u8868\u3001\u516c\u5f0f\u7b49\uff0c\u589e\u5f3a\u6587\u6863\u7684\u8868\u73b0\u529b\u3002<\/p>\n<\/p>\n<p><h2>4.2 \u4f7f\u7528\u65b9\u6cd5<\/h2>\n<\/p>\n<p><p>\u4f7f\u7528 Sphinx \u7684\u7b2c\u4e00\u6b65\u662f\u521b\u5efa\u4e00\u4e2aSphinx\u9879\u76ee\u3002\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u751f\u6210Sphinx\u9879\u76ee\u7684\u57fa\u672c\u7ed3\u6784\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">sphinx-quickstart<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u63a5\u4e0b\u6765\uff0c\u7528\u6237\u53ef\u4ee5\u5728 <code>conf.py<\/code> \u914d\u7f6e\u6587\u4ef6\u4e2d\u8bbe\u7f6e\u5404\u79cd\u9009\u9879\uff0c\u5982\u8f93\u5165\u6587\u4ef6\u3001\u8f93\u51fa\u683c\u5f0f\u7b49\u3002\u7136\u540e\uff0c\u53ef\u4ee5\u5728 <code>.rst<\/code> \u6587\u4ef6\u4e2d\u7f16\u5199\u6587\u6863\u3002\u4f8b\u5982\uff0c\u53ef\u4ee5\u7f16\u5199\u4e00\u4e2a\u7b80\u5355\u7684\u6a21\u5757\u6587\u6863\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-rst\">example module<\/p>\n<p>==============<\/p>\n<p>.. automodule:: example<\/p>\n<p>    :members:<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u6700\u540e\uff0c\u8fd0\u884cSphinx\u547d\u4ee4\u751f\u6210\u6587\u6863\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">make html<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><h2>4.3 \u5b9e\u9645\u5e94\u7528<\/h2>\n<\/p>\n<p><p>\u5728Python\u5f00\u53d1\u4e2d\uff0cSphinx \u662f\u751f\u6210\u6587\u6863\u7684\u5f3a\u5927\u5de5\u5177\u3002\u5f00\u53d1\u56e2\u961f\u53ef\u4ee5\u4f7f\u7528Sphinx \u4e3a\u9879\u76ee\u751f\u6210\u8be6\u7ec6\u7684API\u6587\u6863\uff0c\u5305\u542b\u6a21\u5757\u3001\u7c7b\u3001\u51fd\u6570\u3001\u65b9\u6cd5\u7b49\u4fe1\u606f\uff0c\u65b9\u4fbf\u5f00\u53d1\u8005\u67e5\u9605\u548c\u4f7f\u7528API\u3002<\/p>\n<\/p>\n<p><p>\u6b64\u5916\uff0cSphinx \u8fd8\u5e38\u7528\u4e8e\u751f\u6210\u5e93\u548c\u6846\u67b6\u7684\u6587\u6863\u3002\u901a\u8fc7\u7f16\u5199\u8be6\u7ec6\u7684\u6587\u6863\u548c\u6ce8\u91ca\uff0c\u5f00\u53d1\u8005\u53ef\u4ee5\u4f7f\u7528Sphinx \u751f\u6210\u6807\u51c6\u7684API\u6587\u6863\uff0c\u5e2e\u52a9\u7528\u6237\u4e86\u89e3\u548c\u4f7f\u7528\u5e93\u548c\u6846\u67b6\u7684\u529f\u80fd\u3002<\/p>\n<\/p>\n<h2><strong>\u4e94\u3001DocFX<\/strong><\/h2>\n<p><p>DocFX \u662f\u4e00\u4e2a\u8de8\u5e73\u53f0\u7684\u6587\u6863\u751f\u6210\u5de5\u5177\uff0c\u5e7f\u6cdb\u7528\u4e8e\u751f\u6210.NET\u9879\u76ee\u7684\u6587\u6863\u3002\u5b83\u652f\u6301\u591a\u79cd\u8f93\u51fa\u683c\u5f0f\uff0c\u5e76\u4e14\u53ef\u4ee5\u901a\u8fc7\u914d\u7f6e\u6587\u4ef6\u81ea\u5b9a\u4e49\u751f\u6210\u7684\u6587\u6863\u683c\u5f0f\u548c\u5185\u5bb9\u3002<\/p>\n<\/p>\n<p><h2>5.1 \u529f\u80fd\u7279\u70b9<\/h2>\n<\/p>\n<p><p>DocFX \u6700\u663e\u8457\u7684\u7279\u70b9\u662f\u5176\u8de8\u5e73\u53f0\u652f\u6301\u548c\u591a\u683c\u5f0f\u8f93\u51fa\u3002<strong>\u5b83\u4e0d\u4ec5\u652f\u6301\u751f\u6210HTML\u3001PDF\u7b49\u591a\u79cd\u683c\u5f0f\u7684\u6587\u6863\uff0c\u8fd8\u652f\u6301\u5728Windows\u3001Linux\u3001macOS\u7b49\u591a\u4e2a\u5e73\u53f0\u4e0a\u8fd0\u884c<\/strong>\u3002\u6b64\u5916\uff0cDocFX \u8fd8\u652f\u6301\u901a\u8fc7\u914d\u7f6e\u6587\u4ef6\u81ea\u5b9a\u4e49\u751f\u6210\u7684\u6587\u6863\u683c\u5f0f\u548c\u5185\u5bb9\uff0c\u4fbf\u4e8e\u4e0d\u540c\u7528\u6237\u7684\u9700\u6c42\u3002<\/p>\n<\/p>\n<p><p>DocFX \u4f7f\u7528Markdown\u4f5c\u4e3a\u6587\u6863\u7f16\u5199\u683c\u5f0f\uff0c\u4fbf\u4e8e\u7f16\u5199\u548c\u9605\u8bfb\u3002DocFX \u751f\u6210\u7684\u6587\u6863\u7ed3\u6784\u6e05\u6670\uff0c\u5305\u542b\u7d22\u5f15\u3001\u6982\u8ff0\u3001\u8be6\u7ec6\u63cf\u8ff0\u7b49\u90e8\u5206\uff0c\u65b9\u4fbf\u7528\u6237\u67e5\u9605\u3002\u6b64\u5916\uff0cDocFX \u8fd8\u652f\u6301\u751f\u6210\u56fe\u8868\u3001\u516c\u5f0f\u7b49\uff0c\u589e\u5f3a\u6587\u6863\u7684\u8868\u73b0\u529b\u3002<\/p>\n<\/p>\n<p><h2>5.2 \u4f7f\u7528\u65b9\u6cd5<\/h2>\n<\/p>\n<p><p>\u4f7f\u7528 DocFX \u7684\u7b2c\u4e00\u6b65\u662f\u521b\u5efa\u4e00\u4e2aDocFX\u9879\u76ee\u3002\u53ef\u4ee5\u4f7f\u7528\u4ee5\u4e0b\u547d\u4ee4\u751f\u6210DocFX\u9879\u76ee\u7684\u57fa\u672c\u7ed3\u6784\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">docfx init -q<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u63a5\u4e0b\u6765\uff0c\u7528\u6237\u53ef\u4ee5\u5728 <code>docfx.json<\/code> \u914d\u7f6e\u6587\u4ef6\u4e2d\u8bbe\u7f6e\u5404\u79cd\u9009\u9879\uff0c\u5982\u8f93\u5165\u6587\u4ef6\u3001\u8f93\u51fa\u683c\u5f0f\u7b49\u3002\u7136\u540e\uff0c\u53ef\u4ee5\u5728Markdown\u6587\u4ef6\u4e2d\u7f16\u5199\u6587\u6863\u3002\u4f8b\u5982\uff0c\u53ef\u4ee5\u7f16\u5199\u4e00\u4e2a\u7b80\u5355\u7684\u6a21\u5757\u6587\u6863\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-markdown\"># Example Module<\/p>\n<p>## Functions<\/p>\n<p>### `exampleFunction`<\/p>\n<p>Description of the function.<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><p>\u6700\u540e\uff0c\u8fd0\u884cDocFX\u547d\u4ee4\u751f\u6210\u6587\u6863\uff1a<\/p>\n<\/p>\n<p><pre><code class=\"language-sh\">docfx build<\/p>\n<p><\/code><\/pre>\n<\/p>\n<p><h2>5.3 \u5b9e\u9645\u5e94\u7528<\/h2>\n<\/p>\n<p><p>\u5728.NET\u5f00\u53d1\u4e2d\uff0cDocFX \u662f\u751f\u6210\u6587\u6863\u7684\u5f3a\u5927\u5de5\u5177\u3002\u5f00\u53d1\u56e2\u961f\u53ef\u4ee5\u4f7f\u7528DocFX \u4e3a\u9879\u76ee\u751f\u6210\u8be6\u7ec6\u7684API\u6587\u6863\uff0c\u5305\u542b\u6a21\u5757\u3001\u7c7b\u3001\u51fd\u6570\u3001\u65b9\u6cd5\u7b49\u4fe1\u606f\uff0c\u65b9\u4fbf\u5f00\u53d1\u8005\u67e5\u9605\u548c\u4f7f\u7528API\u3002<\/p>\n<\/p>\n<p><p>\u6b64\u5916\uff0cDocFX \u8fd8\u5e38\u7528\u4e8e\u751f\u6210\u5e93\u548c\u6846\u67b6\u7684\u6587\u6863\u3002\u901a\u8fc7\u7f16\u5199\u8be6\u7ec6\u7684\u6587\u6863\u548c\u6ce8\u91ca\uff0c\u5f00\u53d1\u8005\u53ef\u4ee5\u4f7f\u7528DocFX \u751f\u6210\u6807\u51c6\u7684API\u6587\u6863\uff0c\u5e2e\u52a9\u7528\u6237\u4e86\u89e3\u548c\u4f7f\u7528\u5e93\u548c\u6846\u67b6\u7684\u529f\u80fd\u3002<\/p>\n<\/p>\n<hr>\n<p><p>\u7efc\u4e0a\u6240\u8ff0\uff0c<strong>Doxygen\u3001Javadoc\u3001Pydoc\u3001Sphinx\u3001DocFX<\/strong> \u662f\u5e38\u7528\u7684\u7814\u53d1\u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\u3002\u6bcf\u79cd\u5de5\u5177\u90fd\u6709\u5176\u72ec\u7279\u7684\u529f\u80fd\u548c\u7279\u70b9\uff0c\u5f00\u53d1\u8005\u53ef\u4ee5\u6839\u636e\u9879\u76ee\u7684\u9700\u6c42\u9009\u62e9\u5408\u9002\u7684\u5de5\u5177\u3002<strong>Doxygen \u7684\u591a\u8bed\u8a00\u652f\u6301\u548c\u591a\u683c\u5f0f\u8f93\u51fa\u4f7f\u5176\u6210\u4e3a\u6700\u53d7\u6b22\u8fce\u7684\u5de5\u5177\u4e4b\u4e00\uff0cJavadoc \u548c Pydoc \u5206\u522b\u662fJava\u548cPython\u5f00\u53d1\u4e2d\u7684\u6807\u51c6\u5de5\u5177\uff0c\u800c Sphinx \u548c DocFX \u5219\u56e0\u5176\u7075\u6d3b\u6027\u548c\u53ef\u6269\u5c55\u6027\u53d7\u5230\u5e7f\u6cdb\u6b22\u8fce<\/strong>\u3002<\/p>\n<\/p>\n<h2><strong>\u76f8\u5173\u95ee\u7b54FAQs\uff1a<\/strong><\/h2>\n<p><strong>1. \u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\u662f\u4ec0\u4e48\uff1f<\/strong><br \/>\n\u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\u662f\u4e00\u79cd\u7528\u4e8e\u5e2e\u52a9\u5f00\u53d1\u4eba\u5458\u7f16\u5199\u3001\u7ba1\u7406\u548c\u7ef4\u62a4\u4ee3\u7801\u6ce8\u91ca\u7684\u5de5\u5177\u3002\u5b83\u80fd\u591f\u81ea\u52a8\u63d0\u53d6\u4ee3\u7801\u4e2d\u7684\u6ce8\u91ca\uff0c\u5e76\u4e3a\u5f00\u53d1\u4eba\u5458\u63d0\u4f9b\u7edf\u4e00\u7684\u6ce8\u91ca\u683c\u5f0f\u548c\u89c4\u8303\u3002<\/p>\n<p><strong>2. \u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\u7684\u4f5c\u7528\u662f\u4ec0\u4e48\uff1f<\/strong><br \/>\n\u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\u53ef\u4ee5\u63d0\u9ad8\u4ee3\u7801\u7684\u53ef\u8bfb\u6027\u548c\u53ef\u7ef4\u62a4\u6027\u3002\u5b83\u80fd\u591f\u5e2e\u52a9\u5f00\u53d1\u4eba\u5458\u66f4\u597d\u5730\u7406\u89e3\u4ee3\u7801\u7684\u903b\u8f91\u548c\u529f\u80fd\uff0c\u5e76\u4e14\u53ef\u4ee5\u63d0\u4f9b\u989d\u5916\u7684\u6587\u6863\u8bf4\u660e\uff0c\u65b9\u4fbf\u5176\u4ed6\u5f00\u53d1\u4eba\u5458\u7406\u89e3\u548c\u4fee\u6539\u4ee3\u7801\u3002<\/p>\n<p><strong>3. \u6709\u54ea\u4e9b\u6d41\u884c\u7684\u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\uff1f<\/strong><br \/>\n\u76ee\u524d\u5e02\u573a\u4e0a\u6709\u5f88\u591a\u6d41\u884c\u7684\u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\uff0c\u5982Javadoc\u3001Doxygen\u3001Pydoc\u7b49\u3002\u8fd9\u4e9b\u8f6f\u4ef6\u652f\u6301\u591a\u79cd\u7f16\u7a0b\u8bed\u8a00\uff0c\u5e76\u63d0\u4f9b\u4e86\u4e30\u5bcc\u7684\u529f\u80fd\uff0c\u5982\u81ea\u52a8\u751f\u6210\u6ce8\u91ca\u6a21\u677f\u3001\u4ee3\u7801\u6587\u6863\u751f\u6210\u3001\u6ce8\u91ca\u641c\u7d22\u7b49\u3002\u5f00\u53d1\u4eba\u5458\u53ef\u4ee5\u6839\u636e\u81ea\u5df1\u7684\u9700\u6c42\u9009\u62e9\u9002\u5408\u7684\u8f6f\u4ef6\u6765\u8fdb\u884c\u4ee3\u7801\u6ce8\u91ca\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"\u7814\u53d1\u4ee3\u7801\u6ce8\u91ca\u8f6f\u4ef6\u6709\u54ea\u4e9b\uff1f \u4e3b\u8981\u6709Doxygen\u3001Javadoc\u3001Pydoc\u3001Sphinx\u3001DocFX\u7b49\u3002 \u5176\u4e2d [&hellip;]","protected":false},"author":3,"featured_media":763400,"comment_status":"closed","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[37],"tags":[],"acf":[],"_links":{"self":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/763398"}],"collection":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/comments?post=763398"}],"version-history":[{"count":"1","href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/763398\/revisions"}],"predecessor-version":[{"id":763401,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/763398\/revisions\/763401"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media\/763400"}],"wp:attachment":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media?parent=763398"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/categories?post=763398"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/tags?post=763398"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}