这是做项目时存在的真实情况吗?

小弟最近在从零开始做前后端项目,但有时候看到前几天写的代码得反应一下才行,而且好多文件相似的功能都是直接复制粘贴原来写的代码,然后修改一下。这些代码是不是可以封装一下?虽然我不知道怎么写接口好。。
然后是不是得写个项目文档?但不知道咋写,有时候看到一堆花花绿绿的文件头都大了。。

阅读 1.8k
2 个回答

保持写备注的习惯,以及代码的语义化。看到历史代码的时候就不会看懵了。
相似的功能可以整合抽离出来,一些有细微区别的地方可以做一下适配。或者最后返回的时候使用工厂方法处理成需要的样子。
项目文档是对于整个项目的理解和整理,在复杂业务的时候肯定是需要的了。很多多项目都被吐槽连个README都没有。如果自己间隔半年之后回来看历史的项目,就会和一个新接触的用户一样,有一个文档可以让你更快的恢复状态。

之前有其他人也提问过类似的问题,你可以看看大家的建议大家有过这样的经历嘛? - SegmentFault

个人经验仅供参考

  • 在写功能或者业务代码的时候,先思考拆解过程,将可复用的逻辑或内容抽离成模块或组件。
  • 对逻辑比较复杂的位置,完善注释,有利于后续他人接手和维护。
  • 对于比较复杂的大项目,做好项目文档记录(可以从初始化、运行、打包、插件、整个项目的架构内容等等进行描述)
撰写回答
你尚未登录,登录后可以
  • 和开发者交流问题的细节
  • 关注并接收问题和回答的更新提醒
  • 参与内容的编辑和改进,让解决方法与时俱进
推荐问题