知识卡片
现实示例同时说明输入与输出
parse示例用RSS地址和有意义的字段,让读者看到函数接受什么、返回怎样的迭代结果,比foo/bar更能传达用途。示例应足够完整且说明前提,不能因看似能复制就保证外部URL仍可访问或输出固定。通用语法演示仍可用简短占位符,目标是减少无意义噪声而非禁止一切抽象名称。
这张卡片看不懂?
这张卡片已通过人工审查,不再接受失败反馈。
已有反馈 · 0 条
还没有人提交反馈。
在整书笔记中的位置
原书出处 · 1 处
- 第9章 文档化你的项目 9.1.5 使用现实中的代码示例 · 查看原书依据
代码示例应该可直接在实际程序中复用
参考来源
- 位置:《Python编程精进(第1辑)(套装共3册)(异步图书)》Python高级编程(第2版) · 第9章 文档化你的项目,spine018单元007;来源项目book-sources,extracted/Python编程精进(第1辑)(套装共3册)(异步图书)/_epub-src/OEBPS/text00017.html。
- 结论依据:原文parse用RSS地址和输出字段解释接口,支持示例须表现真实对象与结果形状,外部URL与固定输出仍不作当前承诺。未在本机运行示例或改变环境。
- 原始内容:实际的例子的数量减少到最小。 特别提示 代码示例应该可直接在实际程序中复用。