{"id":1099294,"date":"2025-01-08T15:29:19","date_gmt":"2025-01-08T07:29:19","guid":{"rendered":""},"modified":"2025-01-08T15:29:24","modified_gmt":"2025-01-08T07:29:24","slug":"python%e5%a6%82%e4%bd%95%e5%b0%86%e4%b8%80%e6%95%b4%e6%ae%b5%e6%b3%a8%e9%87%8a-2","status":"publish","type":"post","link":"https:\/\/docs.pingcode.com\/ask\/1099294.html","title":{"rendered":"python\u5982\u4f55\u5c06\u4e00\u6574\u6bb5\u6ce8\u91ca"},"content":{"rendered":"

\"python\u5982\u4f55\u5c06\u4e00\u6574\u6bb5\u6ce8\u91ca\"<\/p>\n

Python\u4e2d\u7684\u6ce8\u91ca\u53ef\u4ee5\u5206\u4e3a\u5355\u884c\u6ce8\u91ca\u548c\u591a\u884c\u6ce8\u91ca\uff0c\u5e38\u7528\u7684\u65b9\u6cd5\u6709\u4f7f\u7528#\u7b26\u53f7\u3001\u4f7f\u7528\u4e09\u4e2a\u5355\u5f15\u53f7\u6216\u4e09\u4e2a\u53cc\u5f15\u53f7\u3001\u4f7f\u7528\u591a\u884c\u5b57\u7b26\u4e32\u548c\u4f7f\u7528pydoc\u6a21\u5757\u3002<\/strong><\/p>\n<\/p>\n

    \n
  1. \u4f7f\u7528#\u7b26\u53f7<\/strong>\uff1a\u8fd9\u662fPython\u4e2d\u6700\u5e38\u7528\u7684\u6ce8\u91ca\u65b9\u5f0f\u3002\u5728\u9700\u8981\u6ce8\u91ca\u7684\u6bcf\u4e00\u884c\u524d\u9762\u52a0\u4e0a#\u7b26\u53f7\u3002<\/li>\n
  2. \u4f7f\u7528\u4e09\u4e2a\u5355\u5f15\u53f7\u6216\u4e09\u4e2a\u53cc\u5f15\u53f7<\/strong>\uff1a\u8fd9\u79cd\u65b9\u6cd5\u5e38\u7528\u4e8e\u51fd\u6570\u3001\u7c7b\u6216\u8005\u6a21\u5757\u7ea7\u522b\u7684\u6587\u6863\u5b57\u7b26\u4e32\uff08docstring\uff09\uff0c\u4e5f\u53ef\u4ee5\u7528\u6765\u6ce8\u91ca\u591a\u884c\u4ee3\u7801\u3002<\/li>\n
  3. \u4f7f\u7528\u591a\u884c\u5b57\u7b26\u4e32<\/strong>\uff1a\u8fd9\u79cd\u65b9\u6cd5\u53ef\u4ee5\u5728\u4e0d\u5f71\u54cd\u4ee3\u7801\u6267\u884c\u7684\u60c5\u51b5\u4e0b\u6dfb\u52a0\u6ce8\u91ca\uff0c\u4f46\u8fd9\u79cd\u65b9\u5f0f\u5e76\u4e0d\u662fPython\u5b98\u65b9\u63a8\u8350\u7684\u6ce8\u91ca\u65b9\u5f0f\u3002<\/li>\n
  4. \u4f7f\u7528pydoc\u6a21\u5757<\/strong>\uff1apydoc\u6a21\u5757\u53ef\u4ee5\u751f\u6210\u6587\u6863\uff0c\u8fd9\u4e9b\u6587\u6863\u53ef\u4ee5\u662f\u6ce8\u91ca\u6216\u8005\u8bf4\u660e\u6587\u6863\u3002\u5b83\u4e3b\u8981\u7528\u4e8e\u751f\u6210HTML\u6587\u6863\u6216\u5728\u63a7\u5236\u53f0\u6253\u5370\u5e2e\u52a9\u4fe1\u606f\u3002<\/li>\n<\/ol>\n

    \u4e0b\u9762\u5c06\u8be6\u7ec6\u4ecb\u7ecd\u8fd9\u51e0\u79cd\u65b9\u6cd5\uff0c\u5e76\u8ba8\u8bba\u5176\u4f18\u7f3a\u70b9\u548c\u9002\u7528\u573a\u666f\u3002<\/p>\n<\/p>\n

    \u4e00\u3001\u4f7f\u7528#\u7b26\u53f7<\/h3>\n<\/p>\n

    \u5728Python\u4e2d\uff0c\u6700\u76f4\u63a5\u548c\u6700\u5e38\u7528\u7684\u6ce8\u91ca\u65b9\u6cd5\u662f\u4f7f\u7528#\u7b26\u53f7\u3002\u6bcf\u4e00\u884c\u8981\u6ce8\u91ca\u7684\u5185\u5bb9\u524d\u9762\u90fd\u52a0\u4e0a#\u7b26\u53f7\u3002\u8fd9\u79cd\u65b9\u6cd5\u7684\u4f18\u70b9\u662f\u7b80\u5355\u660e\u4e86\uff0c\u7f3a\u70b9\u662f\u5bf9\u4e8e\u591a\u884c\u6ce8\u91ca\u6765\u8bf4\u4e0d\u591f\u7b80\u6d01\u3002<\/p>\n<\/p>\n

    # \u8fd9\u662f\u4e00\u4e2a\u5355\u884c\u6ce8\u91ca<\/p>\n
    \u8fd9\u662f\u53e6\u4e00\u4e2a\u5355\u884c\u6ce8\u91ca<\/strong><\/h2>\n
    def example_function():<\/p>\n
        # \u8fd9\u662f\u51fd\u6570\u5185\u90e8\u7684\u6ce8\u91ca<\/p>\n
        a = 10  # \u8fd9\u662f\u4ee3\u7801\u884c\u5c3e\u7684\u6ce8\u91ca<\/p>\n
        return a<\/p>\n
    <\/code><\/pre>\n<\/p>\n
    \u4e8c\u3001\u4f7f\u7528\u4e09\u4e2a\u5355\u5f15\u53f7\u6216\u4e09\u4e2a\u53cc\u5f15\u53f7<\/h3>\n<\/p>\n
    \u4e09\u4e2a\u5355\u5f15\u53f7\uff08'''\uff09\u6216\u8005\u4e09\u4e2a\u53cc\u5f15\u53f7\uff08"""\uff09\u53ef\u4ee5\u7528\u4e8e\u6ce8\u91ca\u591a\u884c\u4ee3\u7801\u3002\u8fd9\u79cd\u65b9\u6cd5\u901a\u5e38\u7528\u4e8e\u6587\u6863\u5b57\u7b26\u4e32\uff08docstring\uff09\uff0c\u4f46\u4e5f\u53ef\u4ee5\u7528\u4e8e\u6ce8\u91ca\u591a\u884c\u4ee3\u7801\u3002\u8fd9\u79cd\u65b9\u5f0f\u7684\u4f18\u70b9\u662f\u53ef\u4ee5\u76f4\u63a5\u6ce8\u91ca\u591a\u884c\uff0c\u7f3a\u70b9\u662f\u53ef\u80fd\u4f1a\u88ab\u8bef\u8ba4\u4e3a\u662f\u6587\u6863\u5b57\u7b26\u4e32\u3002<\/p>\n<\/p>\n
    '''<\/p>\n
    \u8fd9\u662f\u4e00\u4e2a\u591a\u884c\u6ce8\u91ca<\/p>\n
    \u53ef\u4ee5\u6ce8\u91ca\u591a\u884c\u5185\u5bb9<\/p>\n
    '''<\/p>\n
    """<\/p>\n
    \u8fd9\u4e5f\u662f\u4e00\u4e2a\u591a\u884c\u6ce8\u91ca<\/p>\n
    \u53ef\u4ee5\u6ce8\u91ca\u591a\u884c\u5185\u5bb9<\/p>\n
    """<\/p>\n
    def example_function():<\/p>\n
        """<\/p>\n
        \u8fd9\u662f\u51fd\u6570\u7684\u6587\u6863\u5b57\u7b26\u4e32<\/p>\n
        \u53ef\u4ee5\u63cf\u8ff0\u51fd\u6570\u7684\u7528\u9014\u548c\u53c2\u6570<\/p>\n
        """<\/p>\n
        a = 10<\/p>\n
        return a<\/p>\n
    <\/code><\/pre>\n<\/p>\n
    \u4e09\u3001\u4f7f\u7528\u591a\u884c\u5b57\u7b26\u4e32<\/h3>\n<\/p>\n
    \u4f7f\u7528\u591a\u884c\u5b57\u7b26\u4e32\u6ce8\u91ca\u4ee3\u7801\u867d\u7136\u4e0d\u5f71\u54cd\u4ee3\u7801\u7684\u6267\u884c\uff0c\u4f46\u8fd9\u79cd\u65b9\u6cd5\u5e76\u4e0d\u662f\u5b98\u65b9\u63a8\u8350\u7684\u6ce8\u91ca\u65b9\u6cd5\u3002\u5b83\u7684\u4f18\u70b9\u662f\u5728\u4ee3\u7801\u4e2d\u76f4\u63a5\u6dfb\u52a0\u591a\u884c\u5b57\u7b26\u4e32\uff0c\u4e0d\u9700\u8981\u6bcf\u884c\u90fd\u52a0#\uff0c\u7f3a\u70b9\u662f\u5bb9\u6613\u6df7\u6dc6\u548c\u4e0d\u88ab\u5e7f\u6cdb\u63a5\u53d7\u3002<\/p>\n<\/p>\n
    '''<\/p>\n
    \u8fd9\u662f\u4e00\u4e2a\u591a\u884c\u5b57\u7b26\u4e32\u6ce8\u91ca<\/p>\n
    Python\u4f1a\u5ffd\u7565\u5b83<\/p>\n
    '''<\/p>\n
    def example_function():<\/p>\n
        '''<\/p>\n
        \u51fd\u6570\u5185\u90e8\u7684\u591a\u884c\u5b57\u7b26\u4e32\u6ce8\u91ca<\/p>\n
        '''<\/p>\n
        a = 10<\/p>\n
        return a<\/p>\n
    <\/code><\/pre>\n<\/p>\n
    \u56db\u3001\u4f7f\u7528pydoc\u6a21\u5757<\/h3>\n<\/p>\n
    pydoc\u6a21\u5757\u4e3b\u8981\u7528\u4e8e\u751f\u6210Python\u6a21\u5757\u3001\u7c7b\u3001\u51fd\u6570\u7b49\u7684\u6587\u6863\u3002\u4f7f\u7528pydoc\u6a21\u5757\u53ef\u4ee5\u751f\u6210HTML\u6587\u6863\uff0c\u6216\u8005\u5728\u63a7\u5236\u53f0\u663e\u793a\u5e2e\u52a9\u4fe1\u606f\u3002\u8fd9\u79cd\u65b9\u6cd5\u7684\u4f18\u70b9\u662f\u53ef\u4ee5\u751f\u6210\u8be6\u7ec6\u7684\u6587\u6863\uff0c\u9002\u7528\u4e8e\u5927\u578b\u9879\u76ee\uff1b\u7f3a\u70b9\u662f\u5bf9\u4e8e\u7b80\u5355\u7684\u6ce8\u91ca\u6765\u8bf4\u6709\u4e9b\u8fc7\u4e8e\u590d\u6742\u3002<\/p>\n<\/p>\n
    """<\/p>\n
    \u6a21\u5757\u7ea7\u522b\u7684\u6587\u6863\u5b57\u7b26\u4e32<\/p>\n
    \u53ef\u4ee5\u63cf\u8ff0\u6a21\u5757\u7684\u7528\u9014\u548c\u4f7f\u7528\u65b9\u6cd5<\/p>\n
    """<\/p>\n
    def example_function():<\/p>\n
        """<\/p>\n
        \u51fd\u6570\u7684\u6587\u6863\u5b57\u7b26\u4e32<\/p>\n
        \u53ef\u4ee5\u63cf\u8ff0\u51fd\u6570\u7684\u7528\u9014\u3001\u53c2\u6570\u548c\u8fd4\u56de\u503c<\/p>\n
        """<\/p>\n
        a = 10<\/p>\n
        return a<\/p>\n
    if __name__ == "__mAI<\/a>n__":<\/p>\n
        import pydoc<\/p>\n
        pydoc.writedoc('example_module')<\/p>\n
    <\/code><\/pre>\n<\/p>\n
    \u5c0f\u7ed3<\/h3>\n<\/p>\n
    Python\u4e2d\u7684\u6ce8\u91ca\u65b9\u6cd5\u591a\u79cd\u591a\u6837\uff0c\u9009\u62e9\u5408\u9002\u7684\u65b9\u6cd5\u53d6\u51b3\u4e8e\u5177\u4f53\u7684\u573a\u666f\u548c\u9700\u6c42\u3002<\/strong>\u5bf9\u4e8e\u7b80\u5355\u7684\u5355\u884c\u6ce8\u91ca\uff0c\u4f7f\u7528#\u7b26\u53f7\u662f\u6700\u5408\u9002\u7684\uff1b\u5bf9\u4e8e\u591a\u884c\u6ce8\u91ca\uff0c\u4e09\u4e2a\u5355\u5f15\u53f7\u6216\u4e09\u4e2a\u53cc\u5f15\u53f7\u662f\u5e38\u89c1\u7684\u9009\u62e9\uff1b\u5bf9\u4e8e\u9700\u8981\u751f\u6210\u6587\u6863\u7684\u573a\u666f\uff0cpydoc\u6a21\u5757\u662f\u4e00\u4e2a\u5f3a\u5927\u7684\u5de5\u5177\u3002\u65e0\u8bba\u9009\u62e9\u54ea\u79cd\u65b9\u6cd5\uff0c\u6ce8\u91ca\u7684\u76ee\u7684\u662f\u4e3a\u4e86\u63d0\u9ad8\u4ee3\u7801\u7684\u53ef\u8bfb\u6027\u548c\u53ef\u7ef4\u62a4\u6027\uff0c\u56e0\u6b64\u6ce8\u91ca\u5185\u5bb9\u5e94\u5c3d\u91cf\u7b80\u6d01\u660e\u4e86\uff0c\u907f\u514d\u8fc7\u591a\u5197\u4f59\u7684\u6ce8\u91ca\u3002<\/p>\n<\/p>\n
    \u76f8\u5173\u95ee\u7b54FAQs\uff1a<\/strong><\/h2>\n
     \u5982\u4f55\u5728Python\u4e2d\u6709\u6548\u5730\u6dfb\u52a0\u591a\u884c\u6ce8\u91ca\uff1f<\/strong>
    \u5728Python\u4e2d\uff0c\u867d\u7136\u6ca1\u6709\u4e13\u95e8\u7684\u591a\u884c\u6ce8\u91ca\u8bed\u6cd5\uff0c\u4f46\u53ef\u4ee5\u4f7f\u7528\u4e09\u91cd\u5f15\u53f7\uff08'''\u6216"""\uff09\u6765\u5b9e\u73b0\u591a\u884c\u6ce8\u91ca\u3002\u5c06\u9700\u8981\u6ce8\u91ca\u7684\u5185\u5bb9\u653e\u5728\u4e09\u91cd\u5f15\u53f7\u4e4b\u95f4\uff0c\u5c31\u53ef\u4ee5\u6ce8\u91ca\u6389\u591a\u884c\u6587\u672c\u3002\u8fd9\u79cd\u65b9\u6cd5\u4e0d\u4ec5\u53ef\u4ee5\u7528\u4e8e\u6ce8\u91ca\uff0c\u8fd8\u5e38\u7528\u4e8e\u6587\u6863\u5b57\u7b26\u4e32\uff08docstring\uff09\u3002<\/p>\n
    Python\u4e2d\u6ce8\u91ca\u7684\u6700\u4f73\u5b9e\u8df5\u662f\u4ec0\u4e48\uff1f<\/strong>
    \u7f16\u5199\u6e05\u6670\u4e14\u7b80\u6d01\u7684\u6ce8\u91ca\u662f\u975e\u5e38\u91cd\u8981\u7684\u3002\u4fdd\u6301\u6ce8\u91ca\u4e0e\u4ee3\u7801\u903b\u8f91\u4e00\u81f4\uff0c\u907f\u514d\u8fc7\u5ea6\u6ce8\u91ca\u3002\u6ce8\u91ca\u5e94\u5f53\u89e3\u91ca\u201c\u4e3a\u4ec0\u4e48\u201d\u505a\u67d0\u4ef6\u4e8b\uff0c\u800c\u975e\u201c\u5982\u4f55\u201d\u505a\u3002\u5bf9\u4e8e\u590d\u6742\u7684\u7b97\u6cd5\u6216\u4e0d\u6613\u7406\u89e3\u7684\u4ee3\u7801\u6bb5\uff0c\u63d0\u4f9b\u8be6\u7ec6\u7684\u6ce8\u91ca\u53ef\u4ee5\u5e2e\u52a9\u540e\u7eed\u7ef4\u62a4\u548c\u9605\u8bfb\u4ee3\u7801\u7684\u4eba\u3002<\/p>\n
    \u5982\u4f55\u5728Python\u4ee3\u7801\u4e2d\u6392\u67e5\u6ce8\u91ca\u662f\u5426\u5f71\u54cd\u7a0b\u5e8f\u8fd0\u884c\uff1f<\/strong>
    \u5728Python\u4e2d\uff0c\u6ce8\u91ca\u4e0d\u4f1a\u88ab\u89e3\u91ca\u5668\u6267\u884c\uff0c\u56e0\u6b64\u4e0d\u4f1a\u5f71\u54cd\u7a0b\u5e8f\u7684\u8fd0\u884c\u3002\u7136\u800c\uff0c\u5982\u679c\u4f60\u4f7f\u7528\u4e86\u4e09\u91cd\u5f15\u53f7\u6ce8\u91ca\u7684\u5185\u5bb9\uff0c\u4f46\u5fd8\u8bb0\u53bb\u6389\u6216\u9519\u8bef\u5730\u653e\u7f6e\u5728\u4ee3\u7801\u5757\u4e2d\uff0c\u53ef\u80fd\u4f1a\u5bfc\u81f4\u610f\u5916\u7684\u884c\u4e3a\u3002\u786e\u4fdd\u6ce8\u91ca\u7684\u5185\u5bb9\u4e0d\u4f1a\u88ab\u610f\u5916\u5730\u4f5c\u4e3a\u5b57\u7b26\u4e32\u4f7f\u7528\uff0c\u53ef\u4ee5\u901a\u8fc7\u4ed4\u7ec6\u68c0\u67e5\u4ee3\u7801\u903b\u8f91\u548c\u7ed3\u6784\u6765\u907f\u514d\u8fd9\u79cd\u60c5\u51b5\u3002<\/p>\n","protected":false},"excerpt":{"rendered":"Python\u4e2d\u7684\u6ce8\u91ca\u53ef\u4ee5\u5206\u4e3a\u5355\u884c\u6ce8\u91ca\u548c\u591a\u884c\u6ce8\u91ca\uff0c\u5e38\u7528\u7684\u65b9\u6cd5\u6709\u4f7f\u7528#\u7b26\u53f7\u3001\u4f7f\u7528\u4e09\u4e2a\u5355\u5f15\u53f7\u6216\u4e09\u4e2a\u53cc\u5f15\u53f7\u3001\u4f7f\u7528\u591a\u884c\u5b57 […]","protected":false},"author":3,"featured_media":1099302,"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\/1099294"}],"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=1099294"}],"version-history":[{"count":"1","href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/1099294\/revisions"}],"predecessor-version":[{"id":1099305,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/posts\/1099294\/revisions\/1099305"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media\/1099302"}],"wp:attachment":[{"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/media?parent=1099294"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/categories?post=1099294"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/docs.pingcode.com\/wp-json\/wp\/v2\/tags?post=1099294"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}