2019-04-29 关于Mcu_PerformReset和API设计原则

学习AutoSAR的时候,看到在MCAL中有API名为Mcu_PerformReset,撇开AutoSAR对架构本身的优缺点,单说Mcu_PerformReset这一个API。

直观想到的,是Mcu_PerformReset与Mcu_Reset在API命名上的区别。Mcu_PerformReset从API名称可以直译为Mcu执行Reset,很符合API设计的动词+名词原则,但是如果去询问100个软件工程师,我大概能确定有99个不能在这个API的名字中加上Perform,大家都会设计成Mcu_Reset,这是更符合习惯的API命名,所以我很想知道设计这个API的人心里的想法。

讲起API的命名,其实有一套约定俗成而一以贯之的原则。比如大小写混排加下划线,因为在不同的库中有不同的约定,到还不至于太过悖于习惯,但在命名的清晰易懂而有符合习惯上,委实会有常常令人摸不着头脑的地方。还是以Mcu_PerformReset为例,本身的命名固然看起来还不错,不过可以类比一下其他广泛使用的库,以及Linux本身的系统调用,这些库中的API命名,基本上可以代表当前广泛传播的函数命名约定和规范。

在cJSON库中,可以对拿到的json字符串进行解析,使用的API为cJSON_Parse。可以看到在命名规则上,与AutoSAR使用的大小写混排+下划线一致。不过如果依照Mcu_PerformReset,似乎命名为cJSON_PerformParse或者cJSON_DoParse会更加合理,然而如果这么命名,使用的人恐怕只会哭笑不得,因为实在是不能理解。pthread库中也有同样的情形,如果按照Mcu_PerformReset的原则,pthread的API应该是诸如pthread_perform_create,pthread_perform_join之流。kernel的系统调用实现更加不可目视,因为原本简洁的open,需要编程perform_open,而且对于kernel还不能变成do_open,因为内核有do_open的实现,同一系统中的多个do_open更加引起使用者的不适感。

那么在同一个Mcu模块中的明明,是不是能够遵循同样的原则呢?有图为证:

整个模块的API,只有Mcu_PerformReset显得鹤立鸡群,与其他API明明规则格格不入。德国人向来以严谨著称,何以如此?望有人解惑。

所以一份代码的风格,如果不能一以贯之,会引起参与者的极大不适感,且整篇代码在主要API的排布上,应该如流畅的散文一般行云流水,在辅以内部辅助函数,共同组成代码的架构。大体来说,不外函数命名,变量命名,空格规范,换行规范,预处理规范,错误规范几样。然而大部分人写出来的代码还是不忍卒读,甚至做不到格式一致,这固然是因为某些IDE对格式不敏感,但是比如换行,空格等,工程师应该形成手上的习惯,在键入for之后,自然会空格,然后在键入(,不用依赖于IDE的格式整理。IDE的格式整理,实际上培养了工程师的懒惰,以至于写完代码,经由IDE一整理,代码面目全非,他认识你,你不认识他,则开发效率,调试效率简直无从谈起。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容