笔者于 2019 年时曾经写过一篇文章:SAP 官方发布的 ABAP 编程规范。时隔 4 年之后,又有朋友问同样的问题,所以想着再写一篇同样标题的文章,并且把内容做了更新。
老规矩,还是先把问题抛给 ChatGPT:
请问 SAP 官方发布过 ABAP 编程规范吗?如果发布过,请告诉我链接。
ChatGPT 3.5 的回复:
同样的问题抛给微软的 Copilot powered by GPT-4,它给出的答复里,链接 2 和 3 都指向了我发在简书社区上和腾讯云社区上的文章:SAP 官方发布的 ABAP 编程规范。
而链接 1 则直接指向 SAP 官方帮助文档的链接:ABAP Programming Guidelines。
事实说明微软 Copilot 的回答质量还是相当高的。
不知道 SAP 官方发布的 ABAP 编程规范的朋友,理论上通过 AI 工具的问答,也能找到这些编程规范的链接。
链接 2 和 3 共同指向这个 Github 仓库地址。
这份规范分为 Clean ABAP 和 ABAP Code Reviews 两大部分。
存储这份规范的代码仓库,从属于 Github 上 SAP 这个 Organization,说明其权威性。
书写 Clean Code 的一些收益:
- 提高可读性和理解性:清晰的代码更容易阅读和理解,尤其是来自全球不同地区的多个开发团队共同参与同一个复杂项目开发时,Clean Code 使所有的开发人员都更容易适应、调试和维护。
- 减少错误和缺陷的风险:清晰的代码通常更可靠,更不容易出现错误和缺陷,因为它更容易理解、测试和维护。
- 提高适应和演进能力:清晰、模块化的代码更容易修改,更新和持续优化,这有助于软件随着时间的推移进行演变,适应不断变化的需求。
- 改善团队协作:清晰的代码更容易让团队成员理解和合作,这可以改善团队内的协作和沟通。
- 增加代码重用性:清晰、模块化的代码更容易在不同的上下文中重用,从而避免重复造轮子的情况出现,节省开发时间和资源,提高生产率。
- 改善 Code Review 过程:清晰的代码更容易进行代码审查,因为它更有组织且更容易理解。
- 如今 Github CoPilot 这类 AI 辅助工具已经深入到程序员日常工作中。在代码清晰,语义明确的前提下,AI 辅助工具能提供更准确和更相关的代码修改和编写建议。
本文介绍的这个代码仓库,则是 SAP 官方给出的如何书写 Clean ABAP Code 的一些建议。
这份规范有多语言版本,并且有 PDF 版本,方便打印出来随身携带:
PDF 版本长这样:
如果阅读英文有困难的朋友,可以阅读规范的中文版。
这份规范长长的目录:
这些规范里很多条,都值得单独写一篇文章来讨论。
敬请持续关注本公众号后续关于这些规范具体条目的文章。