DocBlockr_Python

由 thep0y ST4

Sublime Text 的 Python DocBlockr。简化了 Python 中文档字符串注释的编写。

详细信息

基于 DocBlockr 项目，此插件提供了类似的功能，但用于 Python 文档字符串。该插件的默认格式化器旨在遵守 PEP-257 标准，但具有更多的可读性：增加了变量类型、列出类扩展和列出装饰器。此项目的目标是通过提供简单和一致的格式化，帮助开发者提供更好的文档。

手动下载发行版并将其放入您的已安装包目录

没有命令面板命令来启动此插件，它会在在 module、class 或 function 级别打开文档字符串（`"""`）后通过按 enter 或 tab 触发。如果您想在打开文档字符串后简单地插入一个新行而不触发格式化器，请按住 ctrl 并按 enter。

您可以通过更新此包的用户设置来配置要使用的文档字符串格式（首选项 > 包设置 > Python DocBlockr > 设置）。

您还可以通过编辑项目文件根据每个项目覆盖用户设置。任何设置都可以在这里覆盖。

{
  "PythonDocblockr": {
    "formatter": "sphinx"
  },
  "folders": [
    // ...
  ]
}