如果有兴趣，可以跟我联系交流：这里

DocStringPermalink

• 按长度分

  • one-line DocString
  • multi-line DocString

• 按风格分

  • Google Style：简洁
  • NumPy Style：简洁+详尽

• 按位置分

  • Class DocString
  • Package and Module DocString
  • Script DocString
  • Function DocString

• 文档生成工具

  • sphinx
  • Read The Docs

参考资料Permalink

• Documenting Python Code: A Complete Guide – Real Python
• (Tutorial) Docstrings in Python - DataCamp