我们在准做项目开发时，准备一个文档是开发过程中最重要的一环 。那么我们如何让文档做起来更漂亮更直观呢，那几天小编就通过这篇文文章来给家分享一个使用Sphinx 为你的 Python 代码添加文档注释的方法 。
文章插图
我们知道，在python中我们可以将文档包含在源代码中，这种的实现方式是基于docstrings来实现的 。尽管文档本身就可以提供很好的说明，但是无法充分说明的代码内容 。接下来一起来跟小编一起来看看这个强大之处 。
大家一定经历过很多次白板手写斐波那契数列吧，小编反正是再也不想白板开始写斐波那契数列来，然后利用python写了一个可重复利用的斐波那契计算器，主要实现方法是利用浮点数的技巧实现了O(1)的复杂度 。其实代码很简单：
# fib.pyimport mathSQRT_5 = math.sart(5)PHI = (1+_SQRT_5) / 2def approx_fib(n):return round(_PHI**(n+1) /_SQRT_5)【如何用Sphinx为你的Python代码添加文档注释？这篇文章看完你就知道】作为一名开发者，我们把代码开源且推到网上去，setup.py文件依旧显得非常简洁：
import setuptoolssetuptools.setup( name= 'fib', version='2019.1.0', description='Fibonacci', py_modules=["fib"],)不过，我们只有代码而没有文档的话那么可以说是毫无用处，所以我们需要在函数内添加了文档字符串 。
小编再给大家分享一个可以添加更多文档的方法，就是在docs/目录下添加rst文件来实现，而且非常有python内味 。
以上就是小编给大家带来的在使用Sphinx 为你的 Python 代码添加文档注释的方法，希望大家通过阅读小编的文章之后能够有所收获！如果大家觉得小编的文章不错的话，可以多多分享给有需要的人 。
推荐阅读
- python中函数如何定义？python函数的调用方法介绍
- 京东展位怎么收费？如何推广？
- 京东开店没商标怎么办？如何申请？
- 淘宝开店需要哪些准备？如何做好？
- 淘宝分销怎么补信誉？要注意什么？
- ps平面图片怎么制作折纸效果？如何用ps快速制作折纸效果？
- ps如何更换图片区域颜色？ps怎么修改图片的部分区域颜色？
- ps如何给高光区域上色？ps给高光区上色的操作教程
- ps海报设计教程 ps如何设计复古撕边人物海报效果？
- ps怎么做拼贴效果图？如何在ps中给图片添加拼贴效果？