好了,我读过PEP 8和PEP 257,也写过很多函数和类的文档字符串,但我有点不确定模块文档字符串中应该包含什么。我认为,它至少应该记录模块导出的函数和类,但我也见过一些模块列出了作者姓名、版权信息
好了,我读过PEP 8和PEP 257,也写过很多函数和类的文档字符串,但我有点不确定模块文档字符串中应该包含什么。我认为,它至少应该记录模块导出的函数和类,但我也见过一些模块列出了作者姓名、版权信息
如何使用Python的文档字符串记录带有参数的方法?编辑:PEP 257给出了这样一个例子:这是大多数Python开发人员使用的约定吗?我还以为你会更正式一点呢,比如环境:Python 2.7.1
所以我完全理解如何使用resample,但文档没有很好地解释选项。所以resample函数中的大多数选项都非常简单,除了这两个:规则:表示目标转换的偏移字符串或对象How:字符串,向下或重新采样的方法
我有一个同事,他坚持认为他的代码不需要注释,这是“自文档”。我已经审阅了他的代码,虽然它比我看到的其他人编写的代码更清晰,但我仍然不同意自文档化代码与经过注释和文档化的代码一样完整和有用。帮我理解一下
我的团队开始使用doxygen记录我们的C代码,特别注意我们的公共API头文件。在doxygen中似乎有很大的灵活性和不同的特殊命令,这很好,但不经过反复试验就不清楚什么是好东西,什么是坏东西。你最喜
在Objective C中,我可以使用#pragma mark来标记符号导航器中的代码片段。由于这是一个C预处理器命令,所以在Swift中不可用。在Swift中有替代品吗,或者我必须使用丑陋的评论吗?
我见过Python中编写文档字符串的几种不同风格,最流行的风格是什么?
如何做多行注释?大多数语言都有块注释符号,比如: