代码规范
这部分内容同步自 Grtsinry43's Docs ,最后一次更新于 2024-07-24。
这里是我个人的代码规范,参考了大型开源项目以及一些知名企业的开发规范,希望大家能够有所收获,也能不断完善这个规范。
为什么要有代码规范?
首先当前的技术趋势都是前后端分离,我们要保证相互的协作开发,需要有详细的代码规范,这样才能保证代码的可读性,可维护性,可扩展性,可测试性等等。 其次,由于代码需要不断维护,不断调整迭代,必要时进行重构,所以我们需要有一套规范来保证代码的质量,减少代码的维护成本。 最后,学习代码规范也便于以后就业,学会了普遍的代码规范,对以后的工作 (准确是和同事的交流和协作) 也是有帮助的。
这里包含了什么?
首先是前后端(前端采用 Vue.js
,后端采用 SpringBoot
或 FastAPI
)的代码以及规范,
然后是数据库的设计规范,运维和产品的相关内容,最后是一些常用的工具的使用规范。
最后更新于 2025/8/18 00:55:08
更新历史
本书还在编写中..
前往 Github Repo 参与讨论或贡献内容。