如果你是要撰写你的“代码开发日志”，有三个最重要的部分
1、未来的规划
主要是一些你在开发过程中涌现的想法，我强烈建议你专门找个软件Or日记本来写，并且可以随身携带（或者同步到你手机）以便你蹲厕所的时候修改
2、已经完成的功能
这时你开发日志最重要的功能，比如【完成了数据类的存储功能】或者【完成了战斗系统的法术模板】 并在其后注明相应功能是如何使用的
3、待解决的问题
如果你陷入一个功能很深而且你的大脑渴望休息，你需要存一个”存档点“，一个不重要的修正可以在代码里下一个TODO并注明，一个开发了一半方法可能会需要你详细的写下当时的思路和步骤
4、团队沟通
如果你是一个团队共同开发，你希望团队注意的修改或者函数变更可以在上注明
再说软工上的开发文档，注意这并不是开发日志，开发日志是因为团队合作或者个人长时间更新的时候为自己”存档“用的，程序员还会需要写开发文档。
最后一点，没人关心你的”代码“，例如你写了一个存储功能，没有人会关心他是怎么存的，你只需要在文档里写明是哪个函数，利用了什么技术（SQLite或者常见的json存档）、数据结构是如何的、有什么功能、要怎么使用。你甚至不需要写流程图，没有用户会关心一台电视机是怎么从接受信号到显像到解析遥控器红外，他们需要的是，耗电如何，使用了什么屏幕，大小如何，什么色彩标准，我按哪个键是换台。
如果真的有人想要深入了解你代码每一步的走向，他会自己去看代码
无 1年前
发布