[程序员] 大家会给只在自己电脑上跑的小脚本写 README 吗?
最近整理以前写的一些小脚本,发现最麻烦的不是代码看不懂,而是完全忘了当时为什么要写、依赖哪个版本、输入文件长什么样。
现在打算给每个脚本至少留这几样:
- 一句话说明用途
- 运行命令和参数示例
- 依赖版本
- 一份最小输入输出样例
- 有坑的地方记一行
但一想到“只是自己用”,又很容易懒得补,最后半年后重新研究一遍。
大家对这种个人脚本一般做到什么程度?是认真写 README ,还是直接在文件头写几行注释,或者靠命令历史和记忆?
via V2EX (author: quanmengli)
最近整理以前写的一些小脚本,发现最麻烦的不是代码看不懂,而是完全忘了当时为什么要写、依赖哪个版本、输入文件长什么样。
现在打算给每个脚本至少留这几样:
- 一句话说明用途
- 运行命令和参数示例
- 依赖版本
- 一份最小输入输出样例
- 有坑的地方记一行
但一想到“只是自己用”,又很容易懒得补,最后半年后重新研究一遍。
大家对这种个人脚本一般做到什么程度?是认真写 README ,还是直接在文件头写几行注释,或者靠命令历史和记忆?
via V2EX (author: quanmengli)