从开源项目看python代码注释

【从开源项目看python代码注释】的更多相关文章

从开源项目看python代码注释

最近看了不少代码,也写了不少代码,所以在看和写之间发现了很多的问题,真的是很多,至少从我的认识来看,有几个地方有很大的改进空间,这里不准备把所有的问题都列举出来,所以就先挑选一个比较明显得来和大家聊聊.回顾流行开源项目的成功,除了功能上的刚需之外,文档也是必不可少的一个环节,没有良好文档的开源项目几乎不可能说是流行的,因为很少人会因为你说了一句使用我的项目就可以怎么怎么样就傻不溜秋得用你的.从我以前开源的项目中大家可能会发现一个比较大的问题就是文档工作做得确实不咋地. 项目中的文档我认为可以分为…

从开源项目看 Python 单元测试

我觉得以前在我开发程序的时候,除了文档,可能单元测试是另外一个让我希望别人都写,但是自己又一点都不想写的东西.但是,随着开发程序的增多,以及自己对 Bug 的修改的增多,我发现,UT 在很大程度上是对我有利的,虽然带来的结果就是可能我的 Dev 时间会增加 20-40% 左右,但是,相比较于一段时间之后突然冒出来一个 Bug,让你摸不着头脑:或者说突然一个接一个的 Bug 在你转测试之后提过来,写 UT 的幸福感和自豪感明显是更高的. 就我目前而言,我认为写单元测试有这么几个好处: 帮助减小代码…

python代码注释 - python基础入门(4)

在 python改变世界,从hello world开始中我们已经完成了第一个python程序,代码是有了,关键是好像好不知道写的啥玩意? 一.什么是代码注释代码注释就是给一段代码加上说明,表明这段代码的作用或者实现的功能,方便别人阅读代码.打个形象的比喻: 问题来了,那个女孩是谁?张三?李四?王五? 加上注释再来一遍:放开小红.大家就都明白了,这个女孩叫小红. 二.为什么写代码要注释 IT圈有一个梗:当我写这段代码的时候,只有上帝和我知道,现在,只有上帝知道.上帝说:这个锅我不背! IT…

python开源项目及示例代码

本页面是俺收集的各种 Python 资源,不定期更新. 下面列出的各种 Python 库/模块/工具,如果名称带超链接,说明是第三方的:否则是 Python 语言内置的. 1 算法 1.1 字符串处理 1.2 数学类 1.3 安全类 2 跨编程语言 2.1 整合 C / C++ 语言 2.2 整合 JVM 平台 2.3 整合 dotNet 平台 2.4 整合 Objective-C 语言 3 操作系统相关 3.1 文件和目录操作 3.2 本地进程间通信(IPC) 3.3 Windows 系统相关…

python开源项目及示例代码（转）

本页面是俺收集的各种 Python 资源,不定期更新. 下面列出的各种 Python 库/模块/工具,如果名称带超链接,说明是第三方的:否则是 Python 语言内置的. 1 算法 1.1 字符串处理 1.2 数学类 1.3 安全类 2 跨编程语言 2.1 整合 C / C++ 语言 2.2 整合 JVM 平台 2.3 整合 dotNet 平台 2.4 整合 Objective-C 语言 3 操作系统相关 3.1 文件和目录操作 3.2 本地进程间通信(IPC) 3.3 Windows 系统相关…