8.2-源码“目录结构”命名规范与“文件名、函数名、变量名”命名规范

本文讨论了代码规范的重要性,包括源码目录结构和文件名的命名规范,强调了遵循编码规范以提高代码可读性和团队协作效率。建议在项目中统一编码风格,并推荐了Google C++ Style Guide作为参考。
摘要由CSDN通过智能技术生成

一、为什么要规范代码格式?

  1. 为了写出简洁整齐的代码
    简洁易读的代码,便于自己日后阅读,同时也方便和你协作开发软件的同事阅读你的代码。尤其在多人协作开发的时候非常重要。因此写代码的时候需要遵循一定的格式规范。规范内容一般包括:函数命名格式、变量命名格式、大小写、缩进、花括号位置、特殊含义的前缀或后缀、注释格式等。

  2. 避免写出“一次性代码”
    有的代码,让人一看就想删除了,然后重新实现,重新编码。这就是有一个编码规范的重要性。也就是说你写的代码,不仅仅要实现逻辑功能。还要保证代码的可读性。方便你自己阅读,也方便你和你合作开发软件的同事阅读。这里的一次性是指代码确实实现了逻辑功能。但是不能二次使用,因为代码不规范,隔一段时间之后,自己或者其他人在看这个代码的时候,发现看不下去,看起来太费劲。导致无法二次使用。

二、一定要遵循某个格式标准吗?

不用,你或者你们公司,完全可以定制一套自己的“代码编码规范”。我们多次提到规范,最终目标是为了让代码“简洁明了”,方便在同事之间合作开发、方面分享代码、方面后人阅读等。所以只要满足这个目标。可以根据自己的喜好定义一套编码规范。
注意一点,当有了规范之后,一定要严格遵循。随性所欲的编码风格,最终写出的代码是“一次性代码”。

无论你使用大家公用的“编码规范”或者你自己定义的“编码规范”都是可以的。但是要注意一点,在一个项目(工程)中,一旦使用了一个“规范”,那么项目中的所有代码都应该遵循。即便是从其他地方复制过来的代码,也应该按照当前项目的编码规范来调整代码格式。千万不要半途而废。

  • 5
    点赞
  • 13
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值