自动文档字符串
插入或更新Python文档字符串；改进的python docblockr
详细信息
安装
- 总计 18K
- Win 7K
- Mac 6K
- Linux 6K
| 8月6日 | 8月5日 | 8月4日 | 8月3日 | 8月2日 | 8月1日 | 7月31日 | 7月30日 | 7月29日 | 7月28日 | 7月27日 | 7月26日 | 7月25日 | 7月24日 | 7月23日 | 7月22日 | 7月21日 | 7月20日 | 7月19日 | 7月18日 | 7月17日 | 7月16日 | 7月15日 | 7月14日 | 7月13日 | 7月12日 | 7月11日 | 7月10日 | 7月9日 | 7月8日 | 7月7日 | 7月6日 | 7月5日 | 7月4日 | 7月3日 | 7月2日 | 7月1日 | 6月30日 | 6月29日 | 6月28日 | 6月27日 | 6月26日 | 6月25日 | 6月24日 | 6月23日 | 6月22日 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 1 | 0 | 1 | 2 | 1 | 3 | 3 | 0 | 2 | 0 | 1 | 0 | 2 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 4 | 3 | 0 | 3 | 1 | 0 | 0 | 0 | 1 | 2 | 0 | 1 | 0 | 3 | 4 | 1 | 1 | 1 | 2 | 0 | 1 |
| Mac | 3 | 1 | 0 | 0 | 4 | 1 | 0 | 1 | 1 | 0 | 0 | 0 | 2 | 0 | 2 | 3 | 1 | 0 | 0 | 1 | 0 | 0 | 0 | 2 | 0 | 0 | 0 | 1 | 2 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 1 |
| Linux | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 2 | 0 | 1 | 1 | 1 | 0 | 1 | 1 | 0 | 0 | 1 | 1 | 0 | 2 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 1 | 0 | 4 | 1 | 1 | 0 | 0 |
说明文件
SublimeAutoDocstring
SublimeText插件，用于在分析函数参数等后插入/更新Python文档字符串。
特点
- 检查函数定义并为每个参数插入占位符
- 检查类/模块属性并为每个插入占位符
- 使用一个命令将单个文档字符串或整个模块从一种风格转换为另一种风格
- 从Python 3注解中提取参数和返回类型信息
- 发现函数中引发的异常并为每个插入占位符
- 重新排列参数以反映它们在函数定义中的顺序
- 自动检测风格：Google 或 Numpy
安装
此插件在 包控制 上有索引。一旦安装了包控制，就可以通过命令面板使用 Package Control: Install Package 来安装此包。
或者，您可以将此存储库解压缩到您的 Packages 目录中。您可以通过在MacOS上使用 Sublime Text > Preferences > Browse Packages... 菜单，或在Linux / Windows上使用 Preferences > Browse Packages... 来轻松打开此目录。
使用方法
使用这些键盘快捷键，或从命令面板中使用以下命令。
- <
cmd+alt+'> 会更新光标前面第一个模块/类/函数的文档字符串。 - <
cmd+alt+shift+'> 会更新当前文件中每个类/方法/函数的文档字符串
注意，在Linux / Windows上，使用 ctrl 代替 cmd。
命令
AutoDocstring: 当前AutoDocstring: 全部：为模块中的所有声明创建或更新docstring。AutoDocstring: 转换...：将光标前面的下一个声明的docstring转换为特定样式。AutoDocstring: 转换全部...：将模块中所有现有的docstring转换为特定样式。
设置
在菜单“偏好设置/软件包设置/AutoDocstring/设置 - 用户”下，可以找到打开设置文件的快捷方式。设置也可以在项目设置文件中名为“AutoDocstring”的JSON哈希（字典）中找到。项目设置将覆盖软件包设置。
default_description（默认="描述"）：描述的填充文本。default_return_name（默认="name"）：Numpy样式仅。默认的返回值参数名。设置为空字符串以保留返回值未命名。default_summary（默认="摘要"）：摘要的填充文本。default_type（默认="TYPE"）：类型的填充文本。default_qstyle（默认=“”“）：用于新docstring的引号类型。inspect_class_attributes（默认=true）：添加/移除类属性以与代码保持同步。inspect_exceptions（默认=true）：添加/移除异常以与代码保持同步。inspect_function_parameters（默认=true）：添加/移除函数参数以与代码保持同步。inspect_module_attributes（默认=true）：添加/移除模块属性以与代码保持同步。optional_tag（默认="optional"）：添加到关键字参数类型的文本。提供空字符串不会为新关键字参数添加特殊内容。sort_class_attributes（默认=true）：是否按字母顺序排序类属性。sort_exceptions（默认=true）：是否按字母顺序排序异常。sort_module_attributes（默认=true）：是否按字母顺序排序模块属性。style（默认=“auto_google”）：可以是“google”、“numpy”或“auto”，根据模块中的其他docstring进行自动检测。如果在自动检测失败的情况下，可以使用类似“auto_google”的内容作为后备。template_order（默认=false）：如果为true，则按照样式模板中出现的顺序重新排序部分。如果为false，保留现有的docstring的节次序。use_snippet（默认=true）：如果为true，则插入代码片段，以便您可以按Tab键在新建的字段（摘要/类型/描述）之间切换。start_with_newline（默认=“”）：以逗号分隔的样式列表('numpy'，'google')，对于这些样式，您希望新的docstring以换行符开始。也可以设置为true或false以影响所有样式。extra_class_newlinesdefault=true：根据PEP257，类的docstring应由额外的空行包围。将此设置为false以获得更紧凑但不太符合PEP257规范的类docstring。keep_previous（默认=false）：如果为true，则始终将现有docstring追加到新更新的docstring。对于处理旧代码可能很有用。