erlang spec

这里陆陆续续添加一些自己总结或借鉴的erlang代码规约

[强制] [推荐] [建议]

=============================

命名

原则—— 命名首先应该清晰,然后才是简洁

模块名:

[强制] 除了像util, time_util, list_util这种通用的util模块外, 项目里其他模块的名字都要统一加上前缀,如: xs_......

函数名:

变量名:

[强制] 函数内变量更新“赋值”,后缀序号不取1,而是直接从2开始(1不如2明显,而且容易和字母 l 混淆)

反例:   Player1 =  Player#player{exp = ...},

            % 此处是一些逻辑处理

            Player2 = Player1#player{lv = ...},

正例: Player2 =  Player#player{exp = ...},

            % 此处是一些逻辑处理

            Player3 = Player2#player{lv = ...},



宏名:

进程字典的key名:

[推荐]


============================

函数相关

1.  [推荐]  除非有充分的理由, 否则不要拿“参数匹配某个特定值”这种做法来代替业务逻辑的case或if 判断(这种写法不直观清晰,不便于代码阅读和维护)

反例:

foo(#player{last_save_time=0}) ->

% 执行last_save_time为0时的处理

% ...;

foo(#player{last_save_time=LastSaveTime}) ->

% 执行last_save_time不为0时的处理

% ...

正例: 宁可直接在foo()函数里写case  LastSaveTime == 0 of的判断, 更好的则是封装一些判断的小函数, 然后调用这些小函数。


===========================================================

进程字典

1. [强制] 进程字典的get, put调用,必须加erlang: 前缀,避免和自定义的函数混淆,也更清晰。

反例:  get(xxx),   put(xxx, yyy)

正例:   erlang:get(xxx),    erlang:put(xxx, yyy)


======================================================

注释

1. [强制] 

所有位于行末的注释,统一用%(一个%)

模块(包括头文件,配置文件)开头的模块说明,用%%%(三个%)作为注释

 函数定义处的函数说明,用%%(两个%)作为注释, 函数内部统一用%(一个%)作为注释

记录体定义处的记录体说明,用%%(两个%)作为注释, 记录体内部统一用%(一个%)作为注释

宏定义处用%%(两个%)作为注释,但如果注释是位于行末,则用%(一个%)


===========================================

头文件

1. [强制] 避免头文件被重复包含的写法,统一如下:

假设有一个player.hrl文件,则:

-ifndef(__PLAYER_HRL__).

-define(__PLAYER_HRL__, 0).

.........

-endif.

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

推荐阅读更多精彩内容