建议: 采用 docstring 的文档格式

随着算法的不断增加,采用单一的文档格式来描述文档可能是有意义的。目前存在以下几种格式: - Google Docstring: https://google.GitHub.io/styleguide/pyguide.html#s3.8-comments-and-docstrings - Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html - Sphinx: https://sphinx-rtd-tutorial.readthedocs.io/en/latest/docstrings.html 存在一些编辑器扩展可以根据所选格式生成文档说明,例如: - VSCode: https://GitHub.com/NilsJPWerner/autoDocstring - Neovim: https://GitHub.com/danymat/neogen 这些格式的示例将在下面的示例部分中介绍。