{"id":447,"date":"2025-10-30T08:03:12","date_gmt":"2025-10-30T00:03:12","guid":{"rendered":"https:\/\/www.idcyz.com\/blog\/?p=447"},"modified":"2025-10-30T08:03:12","modified_gmt":"2025-10-30T00:03:12","slug":"%e6%8f%90%e5%8f%96doc%e4%b8%ad%e6%96%87%e6%a1%a3%e5%ad%97%e7%ac%a6%e4%b8%b2%e7%9a%84%e8%87%b3%e5%85%b3%e9%87%8d%e8%a6%81%e6%80%a7%ef%bc%81","status":"publish","type":"post","link":"https:\/\/www.idcyz.com\/blog\/447.html","title":{"rendered":"\u63d0\u53d6doc\u4e2d\u6587\u6863\u5b57\u7b26\u4e32\u7684\u81f3\u5173\u91cd\u8981\u6027\uff01"},"content":{"rendered":"

\"\u63d0\u53d6doc\u4e2d\u6587\u6863\u5b57\u7b26\u4e32\u7684\u81f3\u5173\u91cd\u8981\u6027\uff01\"<\/p>\n

1. \u63d0\u53d6doc\u4e2d\u6587\u6863\u5b57\u7b26\u4e32\u7684\u5fc5\u8981\u6027<\/h3>\n<\/p>\n

\u5728\u5f00\u53d1\u8fc7\u7a0b\u4e2d\uff0cdoc\u5b57\u7b26\u4e32\u662f\u975e\u5e38\u91cd\u8981\u7684\u4e00\u90e8\u5206\uff0c\u5b83\u63d0\u4f9b\u4e86\u6709\u5173\u51fd\u6570\u3001\u7c7b\u548c\u6a21\u5757\u7684\u6587\u6863\u8bf4\u660e\u3002\u63d0\u53d6doc\u5b57\u7b26\u4e32\u53ef\u4ee5\u5e2e\u52a9\u6211\u4eec\u5feb\u901f\u4e86\u89e3\u4ee3\u7801\u7684\u529f\u80fd\uff0c\u4e5f\u5229\u4e8e\u6587\u6863\u751f\u6210\u548c\u4ee3\u7801\u7ef4\u62a4\u3002\u7279\u522b\u662f\u5728\u5927\u578b\u9879\u76ee\u4e2d\uff0c\u6709\u6548\u7684\u6587\u6863\u80fd\u591f\u663e\u8457\u63d0\u5347\u56e2\u961f\u534f\u4f5c\u548c\u4ee3\u7801\u590d\u7528\u7684\u6548\u7387\u3002\u56e0\u6b64\uff0c\u638c\u63e1\u5982\u4f55\u63d0\u53d6doc\u5b57\u7b26\u4e32\u662f\u6bcf\u4e00\u4e2a\u5f00\u53d1\u8005\u7684\u91cd\u8981\u6280\u80fd\u3002<\/p>\n<\/p>\n

\n

2. doc\u5b57\u7b26\u4e32\u7684\u5185\u5bb9<\/h3>\n<\/p>\n

doc\u5b57\u7b26\u4e32\u901a\u5e38\u5305\u542b\u51e0\u4e2a\u91cd\u8981\u7684\u7ec4\u6210\u90e8\u5206\uff0c\u5305\u62ec\uff1a\u51fd\u6570\u6216\u7c7b\u7684\u7b80\u8981\u63cf\u8ff0\u3001\u53c2\u6570\u7684\u7c7b\u578b\u548c\u542b\u4e49\u3001\u8fd4\u56de\u503c\u7684\u7c7b\u578b\u548c\u542b\u4e49\uff0c\u4ee5\u53ca\u53ef\u80fd\u629b\u51fa\u7684\u5f02\u5e38\u7b49\u3002\u8fd9\u4e9b\u4fe1\u606f\u53ef\u4ee5\u5e2e\u52a9\u7528\u6237\u7406\u89e3\u5982\u4f55\u4f7f\u7528\u8be5\u51fd\u6570\u6216\u7c7b\u3001\u9700\u8981\u4f20\u5165\u4ec0\u4e48\u6837\u7684\u53c2\u6570\u3001\u4f1a\u8fd4\u56de\u4ec0\u4e48\u6837\u7684\u7ed3\u679c\u7b49\u3002<\/p>\n<\/p>\n

\n

3. doc\u5b57\u7b26\u4e32\u7684\u4f4d\u7f6e<\/h3>\n<\/p>\n

doc\u5b57\u7b26\u4e32\u901a\u5e38\u4f4d\u4e8e\u51fd\u6570\u6216\u7c7b\u5b9a\u4e49\u7684\u9996\u884c\uff0c\u662f\u4e00\u4e2a\u4e09\u91cd\u5f15\u53f7\u62ec\u8d77\u6765\u7684\u5b57\u7b26\u4e32\u3002\u5bf9\u4e8e\u7c7b\uff0cdoc\u5b57\u7b26\u4e32\u63cf\u8ff0\u7c7b\u7684\u7528\u9014\uff1b\u5bf9\u4e8e\u51fd\u6570\uff0cdoc\u5b57\u7b26\u4e32\u5e94\u8be5\u63cf\u8ff0\u51fd\u6570\u7684\u529f\u80fd\u548c\u53c2\u6570\u3002\u6b63\u786e\u5730\u4e66\u5199doc\u5b57\u7b26\u4e32\uff0c\u4e0d\u4ec5\u5173\u4e4e\u4ee3\u7801\u7684\u53ef\u8bfb\u6027\uff0c\u4e5f\u5173\u4e4e\u56e2\u961f\u5408\u4f5c\u7684\u987a\u7545\u7a0b\u5ea6\u3002<\/p>\n<\/p>\n

\n

4. \u63d0\u53d6doc\u5b57\u7b26\u4e32\u7684\u65b9\u6cd5<\/h3>\n<\/p>\n

\u5bf9\u4e8ePython\u5f00\u53d1\u8005\uff0c\u53ef\u4ee5\u4f7f\u7528\u5185\u7f6e\u7684`__doc__`\u5c5e\u6027\u6765\u63d0\u53d6doc\u5b57\u7b26\u4e32\u3002\u53ea\u9700\u5728\u5b9a\u4e49\u7684\u51fd\u6570\u6216\u7c7b\u540e\u52a0\u4e0a`.__doc__`\u5373\u53ef\u83b7\u53d6\u3002\u4ee5\u4e0b\u662f\u5177\u4f53\u7684\u793a\u4f8b\uff1a<\/p>\n<\/p>\n

<\/p>\r\n
def example_function(param1, param2):<\/p>\r\n
    \"\"\"\u8fd9\u662f\u4e00\u4e2a\u793a\u4f8b\u51fd\u6570\u3002<\/p>\r\n    \r\n
    \u53c2\u6570\uff1a<\/p>\r\n
    param1: \u7b2c\u4e00\u4e2a\u53c2\u6570\uff0c\u7c7b\u578b\u4e3aint\u3002<\/p>\r\n
    param2: \u7b2c\u4e8c\u4e2a\u53c2\u6570\uff0c\u7c7b\u578b\u4e3astr\u3002<\/p>\r\n    \r\n
    \u8fd4\u56de\uff1a<\/p>\r\n
    \u8fd4\u56de\u4e00\u4e2a\u5b57\u7b26\u4e32\uff0c\u8868\u793a\u5904\u7406\u7ed3\u679c\u3002<\/p>\r\n
    \"\"\"<\/p>\r\n
    return f\"\u5904\u7406\u7ed3\u679c\u662f\uff1a{param1}\u548c{param2}\"<\/p>\r\n\r\n
# \u63d0\u53d6doc\u5b57\u7b26\u4e32<\/p>\r\n
print(example_function.__doc__)<\/p>\r\n
<\/code><\/pre>\n<\/p>\n
\n
5. \u63a8\u8350\u7684\u5de5\u5177\u548c\u5e93<\/h3>\n<\/p>\n
\u5bf9\u4e8e\u9700\u8981\u63d0\u53d6\u548c\u751f\u6210\u6587\u6863\u5b57\u7b26\u4e32\u7684\u9879\u76ee\uff0c\u63a8\u8350\u4f7f\u7528Sphinx\u6216pydoc\u7b49\u5de5\u5177\u3002Sphinx\u53ef\u4ee5\u6839\u636edoc\u5b57\u7b26\u4e32\u81ea\u52a8\u751f\u6210\u6587\u6863\uff0c\u652f\u6301\u591a\u79cd\u8f93\u51fa\u683c\u5f0f\uff0c\u5982HTML\u548cPDF\u3002\u800cpydoc\u5219\u7b80\u5355\u6613\u7528\uff0c\u53ef\u4ee5\u751f\u6210Python\u6a21\u5757\u7684\u6587\u6863\u3002\u5229\u7528\u8fd9\u4e9b\u5de5\u5177\uff0c\u53ef\u4ee5\u6781\u5927\u63d0\u9ad8\u6587\u6863\u751f\u6210\u7684\u6548\u7387\u3002<\/p>\n<\/p>\n
\n
6. \u4e3a\u4ec0\u4e48\u8981\u63d0\u53d6doc\u5b57\u7b26\u4e32<\/h3>\n<\/p>\n
\u63d0\u53d6doc\u5b57\u7b26\u4e32\u6700\u76f4\u63a5\u7684\u597d\u5904\u662f\u8282\u7701\u65f6\u95f4\u3002\u5f53\u4f60\u9700\u8981\u8c03\u8bd5\u6216\u4fee\u6539\u4ee3\u7801\u65f6\uff0c\u76f4\u63a5\u67e5\u770bdoc\u5b57\u7b26\u4e32\u80fd\u5e2e\u52a9\u4f60\u5feb\u901f\u7406\u89e3\u4e00\u4e2a\u51fd\u6570\u6216\u7c7b\u7684\u529f\u80fd\uff0c\u907f\u514d\u4e86\u6df1\u5165\u4ee3\u7801\u5b9e\u73b0\u903b\u8f91\u7684\u7e41\u7410\u3002\u540c\u65f6\uff0c\u6587\u6863\u7684\u5b8c\u6574\u6027\u4e5f\u80fd\u51cf\u5c11\u56e2\u961f\u6210\u5458\u4e4b\u95f4\u7684\u6c9f\u901a\u6210\u672c\uff0c\u63d0\u9ad8\u5f00\u53d1\u6548\u7387\u3002<\/p>\n<\/p>\n
\n
7. doc\u5b57\u7b26\u4e32\u662f\u5426\u9002\u7528\u4e8e\u6240\u6709\u7f16\u7a0b\u8bed\u8a00\uff1f<\/h3>\n<\/p>\n
doc\u5b57\u7b26\u4e32\u662f\u5426\u9002\u7528\u4e8e\u6240\u6709\u7f16\u7a0b\u8bed\u8a00\uff1f<\/b>  <\/p>\n
\u5e76\u4e0d\u662f\u6240\u6709\u7f16\u7a0b\u8bed\u8a00\u90fd\u6709\u7c7b\u4f3cdoc\u5b57\u7b26\u4e32\u7684\u6587\u6863\u5f62\u5f0f\uff0c\u4f46\u5927\u90e8\u5206\u73b0\u4ee3\u8bed\u8a00\u90fd\u901a\u8fc7\u4e00\u4e9b\u65b9\u5f0f\u5b9e\u73b0\u6587\u6863\u6ce8\u91ca\u529f\u80fd\uff0c\u4f8b\u5982Java\u7684\u6ce8\u91ca\u3001C#\u7684XML\u6ce8\u91ca\u7b49\u3002\u8fd9\u4e9b\u8bed\u8a00\u4e5f\u90fd\u9f13\u52b1\u5f00\u53d1\u8005\u5728\u4ee3\u7801\u4e2d\u52a0\u5165\u6587\u6863\uff0c\u4ee5\u63d0\u5347\u4ee3\u7801\u7684\u53ef\u8bfb\u6027\u4e0e\u53ef\u7ef4\u62a4\u6027\u3002<\/p>\n<\/p>\n
\n
8. doc\u5b57\u7b26\u4e32\u7f3a\u5931\u7684\u540e\u679c\u662f\u4ec0\u4e48\uff1f<\/h3>\n<\/p>\n
\u5982\u679cdoc\u5b57\u7b26\u4e32\u7f3a\u5931\uff0c\u4f1a\u6709\u4ec0\u4e48\u540e\u679c\uff1f<\/b>  <\/p>\n
\u7f3a\u5931doc\u5b57\u7b26\u4e32\u4f1a\u5bfc\u81f4\u4ee3\u7801\u7684\u53ef\u8bfb\u6027\u548c\u53ef\u7ef4\u62a4\u6027\u964d\u4f4e\u3002\u540e\u7eed\u7684\u5f00\u53d1\u4eba\u5458\u53ef\u80fd\u9700\u8981\u82b1\u8d39\u66f4\u591a\u65f6\u95f4\u53bb\u7406\u89e3\u51fd\u6570\u6216\u7c7b\u7684\u7528\u9014\uff0c\u589e\u52a0\u4e86\u51fa\u9519\u7684\u98ce\u9669\u3002\u6b64\u5916\uff0c\u7f3a\u4e4f\u6587\u6863\u4e5f\u53ef\u80fd\u5f71\u54cd\u5230\u56e2\u961f\u6210\u5458\u4e4b\u95f4\u7684\u6c9f\u901a\u4e0e\u534f\u4f5c\uff0c\u52a0\u5927\u4e86\u9879\u76ee\u7ba1\u7406\u7684\u96be\u5ea6\u3002<\/p>\n<\/p>\n
\n
9. \u5982\u4f55\u786e\u4fdddoc\u5b57\u7b26\u4e32\u7684\u8d28\u91cf\uff1f<\/h3>\n<\/p>\n
\u5982\u4f55\u786e\u4fdddoc\u5b57\u7b26\u4e32\u7684\u8d28\u91cf\uff1f<\/b>  <\/p>\n
\u786e\u4fdddoc\u5b57\u7b26\u4e32\u8d28\u91cf\u7684\u5173\u952e\u5728\u4e8e\u9075\u5faa\u4e00\u81f4\u6027\u548c\u7b80\u6d01\u6027\u539f\u5219\u3002\u4f7f\u7528\u6807\u51c6\u5316\u7684\u6587\u6863\u683c\u5f0f\uff0c\u4fdd\u6301\u6587\u6863\u7684\u5185\u5bb9\u6e05\u6670\u660e\u4e86\uff0c\u907f\u514d\u6b67\u4e49\u3002\u540c\u65f6\uff0c\u5b9a\u671f\u5ba1\u67e5\u548c\u66f4\u65b0\u6587\u6863\uff0c\u4ee5\u786e\u4fdd\u4fe1\u606f\u7684\u51c6\u786e\u6027\u548c\u53ca\u65f6\u6027\u3002\u6b64\u5916\uff0c\u4f7f\u7528\u81ea\u52a8\u5316\u5de5\u5177\u68c0\u67e5\u4ee3\u7801\u548c\u6587\u6863\u4e4b\u95f4\u7684\u4e00\u81f4\u6027\uff0c\u53ef\u4ee5\u5e2e\u52a9\u53ca\u65f6\u53d1\u73b0\u95ee\u9898\u3002<\/p><\/p>\n","protected":false},"excerpt":{"rendered":"
1. \u63d0\u53d6doc\u4e2d\u6587\u6863\u5b57\u7b26\u4e32\u7684\u5fc5\u8981\u6027 \u5728\u5f00\u53d1\u8fc7\u7a0b\u4e2d\uff0cdoc\u5b57\u7b26\u4e32\u662f\u975e\u5e38\u91cd\u8981\u7684\u4e00\u90e8\u5206\uff0c\u5b83\u63d0\u4f9b\u4e86\u6709\u5173\u51fd\u6570\u3001\u7c7b\u548c\u6a21\u5757\u7684\u6587\u6863\u8bf4\u660e\u3002\u63d0\u53d6doc\u5b57\u7b26\u4e32\u53ef\u4ee5\u5e2e\u52a9\u6211\u4eec\u5feb\u901f\u4e86\u89e3\u4ee3\u7801\u7684\u529f\u80fd\uff0c\u4e5f\u5229\u4e8e\u6587\u6863\u751f\u6210\u548c\u4ee3\u7801\u7ef4\u62a4\u3002\u7279\u522b\u662f\u5728\u5927\u578b\u9879\u76ee\u4e2d\uff0c\u6709\u6548\u7684\u6587\u6863\u80fd\u591f\u663e\u8457\u63d0\u5347\u56e2…<\/p>\n","protected":false},"author":1,"featured_media":448,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[242,243,244],"topic":[],"class_list":["post-447","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-jiushu","tag-doc","tag-243","tag-244"],"_links":{"self":[{"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/posts\/447","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/comments?post=447"}],"version-history":[{"count":1,"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/posts\/447\/revisions"}],"predecessor-version":[{"id":450,"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/posts\/447\/revisions\/450"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/media\/448"}],"wp:attachment":[{"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/media?parent=447"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/categories?post=447"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/tags?post=447"},{"taxonomy":"topic","embeddable":true,"href":"https:\/\/www.idcyz.com\/blog\/wp-json\/wp\/v2\/topic?post=447"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}