查看原文
其他

别用代码逼死你的队友

2017-06-05 吴建超 芯片之家


现代各行各业早已不是一个人单打独斗,编程也不例外。随着科技的发展,每项软件项目越来越庞大,需要多人合作方可完成,况且常有队员中途加入退出,当你需要修改年代已久的代码时,你是否会不禁爆出“what the fuck 谁写的什么鬼,重新写算了”,或许这段代码是你自己半年前写的呢!



however,优良统一的编程风格能够最低限度降低成本,能让团队所有人轻松阅读理解和修改,对接手项目的新成员也能更快入手,甚至半年后的自己也能轻松理解当初自己的思路。


避免别人像我fuck别人一样fuck我(什么鬼,有点绕),笔者整理出几项重要的规范思想,并强力在所任职公司推广(把混乱拉回规范可谓心累。。。。。在此45度仰望星空,宝宝不哭),现在和大家分享,当然仅供参考。。。。。。

  • 编程规范必须是企业级,至少是项目级,同一个团队仅需同一套规范。而且规范需要精简而全面、强制中带有弹性,新员工入职必须先熟悉规范在参与项目。

  • 必须强调代码首先是给人看,其次才是给机器理解(相信很多人有异议),在整个软件生命周期里,涉及到开发、测试、生产、升级与维护,这些都需要人,只有易读易维护的代码才有其继续存在的意义。

  • 尽量用库函数,除了malloc和free,尽量使用简单清晰的语法,尽量遵循语言标准,C就要参考ANSI C标准。

  • 注释是重中之重,笔者公司原来代码基本木有注释,看的呀你想吐血,一个函数几百行,浪费几分钟看完了依然不知想表达什么。注释不可少也不可多余,更加不能出错,出错的注释会把老司机带沟里去。

  • 开发环境必须要统一,IAR就要统一版本,否则旧版本打不开新版本创建的工程,用sourceInsight就别用Clion,否则两种工具转来换去,把代码的中文都不知转成了什么编码了(别问我怎么知道,说来都是泪)

    (对,乱码就是中文,整个工程十万多行,5个版本后才发现,工具已无法转换回来,只能靠人工)

  • 六、七、八。。。还有一大堆废话,算了不瞎扯蛋了。

这些都是泛泛而谈瞎扯淡,具体还是靠各位读者重视才是。总之要以规范为中心,坚持简单方便、可移植、可复用、可维护四项基本原则,把我们建设成一眼秒懂的现代化代码世界。


大家有什么想吐槽的呢?欢迎留言


您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存