知识卡片
接口文档需要人工安排重点
从docstring内省生成模块说明能贴近对象接口,却未必知道读者关心什么或怎样串起跨模块任务。独立说明文件可提供更完整结构,但需进入更新流程;两种形式可结合,不能单按文档占代码50%就判断优劣。pydoc、Epydoc和Plone只是原书例子,不把自动提取等同内容已完整。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第9章 文档化你的项目 构建文档集 · 查看原书依据
无法智能的选择感兴趣的模块生成文档
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元017;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文指出自动生成不能智能选重点,直接支持docstring提取与读者任务组织互补,自动化输出不证明内容完整。未在本机运行示例或改变环境。
- 原始内容:的最新集合。 这种方法的主要问题如下。 无法智能的选择感兴趣的模块生成文档。 代码可能会被文档混淆。 此外,模块文档提供的例子有时可能涉及模块的多个部分,并且它们很难在函数和类的docstrings之间进行拆分。模块的docstring的目的是