TE
科技回声
首页24小时热榜最新最佳问答展示工作
GitHubTwitter
首页

科技回声

基于 Next.js 构建的科技新闻平台,提供全球科技新闻和讨论内容。

GitHubTwitter

首页

首页最新最佳问答展示工作

资源链接

HackerNews API原版 HackerNewsNext.js

© 2025 科技回声. 版权所有。

How do you document your python code?

8 点作者 samrohn778将近 7 年前
What are the best practices? Do you use Sphinx. If so how does your deployment look like? Is it worth the effort for a small startup to spend time and effort on it?

2 条评论

mpetyx将近 7 年前
It totally depends on what you want to succeed. In our case, for example, we break our python code into microservices so it is more important documenting the APIs rather the code itself. If you are building complicated libraries, yes sphinx is the choice to go. Most important of all is to understand your deployments and your code lifecycle.
评论 #17417468 未加载
xstartup将近 7 年前
Our python projects have &lt;50 files. Each file with &lt;100LOC.<p>There are hardly any comments on the projects. So, far we&#x27;ve not faced any issue.