记录python docstring规范

发表于 更新于 分类于 本文字数： 304 阅读时长 ≈ 2 分钟
python doctring书写有规范，记录下

前言

docstring没有规范的话，开发大点的项目效率会变低，所以需要遵守docstring的书写规范。

CSDN上找了一个写的很好的文章了，我就不写了，直接放上了博客的链接，下面再加下其中提到的重要的文献资源。

  1. python 官网对于docstring的说明 https://peps.python.org/pep-0257/
  2. 有人翻译1的文档中重要的部分，https://zhuanlan.zhihu.com/p/106799986
  3. google styleguide https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings