如何在Python中注释掉一段代码块
有没有一种机制可以注释掉大量的Python代码？ 目前，我所知道注释代码的方式是在每行前加上# 或将代码用三个引号括起来："""。 这些方式的问题在于：在每一行前添加#太麻烦，而"""会使我想用作注释的字符串出现在生成的文档中。 经过阅读所有评论，答案似乎是“没有”。
如何在Pylint中禁用文件级别的“缺少docstring”警告？
Pylint发出错误，指出某些文件缺少文档字符串。我尝试为每个类、方法和函数添加文档字符串，但似乎Pylint还会检查文件是否应该在开头有一个文档字符串。我能否以某种方式禁用此功能？ 我希望在class、function或method内部缺少docstring时收到通知，但不需要强制要求文件具...
如何在Python中记录类属性？
我正在编写一个轻量级类，其属性旨在公开访问，并且有时在特定实例化中被覆盖。 Python语言中没有为类属性或任何属性创建文档字符串的规定。如果应该有一种期望和支持的方式来记录这些属性，那么是什么？目前，我正在执行以下操作： class Albatross(object): """A ...
使用javadoc来编写Python文档
我目前正在学习Python，我有很强的PHP背景，并且在PHP中，我已经养成了使用javadoc作为文档模板的习惯。 我想知道在Python中，javadoc是否适用于docstring文档。 这里是否有已建立的约定和/或官方指南？ 例如，类似以下内容是否过于详细以适应Python思维方式，还...
Python类继承中如何继承文档字符串
我正在尝试在Python中进行一些类继承。 我希望每个类和继承的类都有良好的文档字符串。 因此，我认为对于继承的类，我想要： 继承基类文档字符串 可能将相关的额外文档附加到文档字符串中 在类继承情况下是否有任何（可能优雅或Pythonic的）方法来进行这种文档字符串操作？ 对于多重继承呢？
如何使用Doxygen记录Python代码
我喜欢使用Doxygen来创建C或PHP代码的文档。我即将开始一个Python项目，并且我记得Python没有/* .. */ 注释，而且它有自己的自我文档功能，这似乎是用Python记录文档的方式。 鉴于我熟悉Doxygen，我如何使用它来生成我的Python文档？我需要特别注意什么吗？
当执行Python文件时，我如何打印出它的文档字符串？
我有一个带有文档字符串的Python脚本。当命令行参数解析失败时，我想打印文档字符串以便用户了解。 是否有任何方法可以实现这一点？ 最小示例#!/usr/bin/env python """ Usage: script.py This describes the script. """ ...
在类和__init__文档字符串中应该记录什么内容已经达成共识了吗？
我没有找到关于在类和__init__文档字符串中应该记录什么的最佳实践。有时我发现构造函数参数已经在类文档字符串中记录了，有时它们也被描述在__init__文档字符串中。我更喜欢在类文档字符串中描述构造函数，因为这是创建新实例时需要调用的内容。那么，__init__方法的文档字符串应该记录什么...
给命名元组添加文档字符串？
有没有一种简单的方式给namedtuple添加文档字符串？ 我尝试过：from collections import namedtuple Point = namedtuple("Point", ["x", "y"]) """ A point in 2D space """ # Yet ...