随记（6）实用的函数命名规则、及注释格式一、命名二、注释格式三、api统一写在模块上部，其他接口写在模块下部（全部导出）四、函数命名规则（记录、列表）

72 阅读 0 评论 48 点赞

我是靠谱客的博主无奈钢笔，最近开发中收集的这篇文章主要介绍随记（6）实用的函数命名规则、及注释格式一、命名二、注释格式三、api统一写在模块上部，其他接口写在模块下部（全部导出）四、函数命名规则（记录、列表），觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

一、命名

get //获得
update //更新
getInstance //获得实例
upData //数据更新
onRender //渲染
init… //初始化…
set… //设置/更改
loadFile //装载文件
add…by… //添加…
moveDown //移动
backup //备份
revert //恢复
count //计数
londFile //读取文件
Birth //初始
Vaule //值
index //索引
create… //创建
Entity //（父类用）
Monster //怪物
Scene //场景
Node //节点
director //主管
stance //立场
select //挑选
refresh //更新、使…恢复
Global //全局、全球
Register //注册
Controller //控制器、

二、注释格式

模块开头

%%--------------------------------------------------------
%% Author : 1550563435@qq.com
%% Create by : wuhuiming
%% Description : 公共服务模块
%%--------------------------------------------------------

导出函数

-export([
set_int_data/2,
%%-----设置或更改int字段
get_int_data/2
%%-----获取Id对应的int字段
]).

函数前以及函数内

%%--------------------------------------------------------
%% @doc
%% 设置或更改init的字段
%% @end
%%--------------------------------------------------------
set_int_data (Id, Data) when is_number(Data) ->
Tran = fun() ->
case get_player_data(Id) of
null ->
PlayerServerData = #player_server_data{id = Id, data = Data},
database:write(PlayerServerData);
Record ->
database:write(Record #player_server_data{data = Data})
end
end,
database:do(Tran). %% 执行事务

三、api统一写在模块上部，其他接口写在模块下部（全部导出）

四、函数命名规则（记录、列表）

方法命名 get_grid_equipment (PlayerId, GridId)返回记录 get_grid_equipment_list (PlayerId)返回列表,命名规范

-export([
api_open_panel/1,
%%-----获得技能面板数据
api_put_skill/3,
%%-----装备技能
api_off_skill/2,
%%-----卸下技能
api_practice_skill/2,
%%-----修炼技能
api_complete_practice/1,
%%-----完成修炼
api_drag_skill/3,
%%-----拖动技能(技能格子)
api_stop_practice/1
%%-----停止修炼
]).
-export([
get_skill_list/1,
%%-----获得玩家技能{skill_id, lv, exp}列表
get_grid_skill_list/1,
%%-----获得玩家技能{grid_id, skill_id}列表
get_practice_skill/1,
%%-----获得玩家正在修炼的技能id	0-未修炼/其他-正在修炼
get_practice_time/1,
%%-----获得玩家可修炼的最大时间/分钟
get_player_skill/2,
%%-----获得玩家技能{player_skill}记录
get_grid_skill/2,
%%-----获得玩家格子对应的player_grid_skill记录
get_remain_cost/1,
%%-----获得玩家剩余（可用）内力值
do_put_skill/3,
%%-----执行装备技能操作
get_skill_lv_limit/1,
%%-----获得技能的最高等级
get_player_practice/1,
%%-----获得玩家修炼信息{player_practice}记录
get_add_exp/1,
%%-----修炼时间获得的经验（公式）
increase_skill_exp/3,
%%-----加技能经验
active_skill/2
%%-----激活技能
]).