Question

我正在开展一个项目，我希望我的代码尽可能干净。我想知道是否在类中包含docstrings它被认为是干净的代码。例如，我的一个类定义如下：

class Hotel:
    """Class to model the rating and rates of a hotel."""

    def __init__(self, rating):
        """
        :type rating: int
        :param rating: hotel rating
        """
        self.rating = rating

我编写代码的方式是否正确，即我遵循干净的代码标准。

提前致谢。

Answer 1

清洁代码部分是意见问题。但是我所知道的大多数Python都支持包括类和方法文档字符串。例如，Google Python Style Guide说：

函数必须具有docstring，除非它满足以下所有条件   标准：


无法外部显示

很短

明显


...

也就是说，除了拥有它们之外，还有更多好的文档;一个好的开始就是问自己，如果我以前从未见过它，我需要使用这个类（或函数）？

在Python中包含docstrings是干净代码的一部分吗？

1 个答案: