在记录python时为什么要使用注释?

亚历克·阿拉迈丁

有两种方法可以在代码本身中记录模块,函数或类:commentsdocstrings

Docstrings具有更多的功能,因为可以通过help()函数访问它们,而comments只能在源代码中访问。

什么时候应该使用注释代替docstrings

gmds

Docstrings旨在从用户的角度解释函数执行的功能以及该函数执行和返回的值的类型和类型。

评论,而另一方面,在源代码中的身体之中,将只对那些实际阅读可见并因此用来解释如何它它做什么。

本文收集自互联网,转载请注明来源。

如有侵权,请联系 [email protected] 删除。

编辑于
0

我来说两句

0 条评论
登录 后参与评论

相关文章

为什么我们要使用@Modifying注释在数据JPA查询

为什么要使用@PostConstruct?

在JavaScript中返回时为什么要使用括号?

通过ajax提交时为什么要使用表单标签?

在python中,为什么要使用日志记录而不是print?

为什么要使用ivar?

在spring boot config类中,为什么要使用Bean注释并设置方法“ public”?

Spring:当我的班级已经用@RestController注释时,为什么还要使用@RequestBody?

为什么只有在记录捕获的异常时,squid:S1166不接受异常消息?

通过AJAX上传文件时,为什么要使用FormData?

为什么要使用“代码”将代码包含在注释中?

范围反转时为什么要使用range_iterator?

当数组更快时,为什么要使用列表?

当显示缓慢时,为什么要使用本机反应

python为什么要使用setter?

流类型注释:为什么要使用“ ClassName <{}>”?

当您拥有componentDidUpdate时,为什么要使用getDerivedStateFromProps?

当我们只需使用代码编写文件时,为什么要使用日志记录库?

当python中有.discard(elem)时,为什么要使用.remove(elem)?

为什么我要使用python硒从Chrome下载文件时为什么出现错误

拥有WebView时为什么要使用ImageView?

为什么要使用缓存

为什么在使用shebang时需要使文件可执行?

为什么要使用ppa?

使用 tkinter 时,为什么要使用“间接”回调?

Xcode:为什么我的启动参数在记录 UI 测试时不起作用?

为什么反应状态(useState)在记录时更新但没有更新?

为什么删除重载时需要使用声明

为什么要使用@Inject 注释?(安卓)