Signed-off-by: Wu Fengguang wfg@mail.ustc.edu.cn --- doc/code-spec.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/doc/code-spec.md b/doc/code-spec.md index a859239..d405cdd 100644 --- a/doc/code-spec.md +++ b/doc/code-spec.md @@ -4,8 +4,11 @@ code注意事项 - 代码应当放进函数里 不要在脚本顶层直接写逻辑 - 代码应当放进lib/里 脚本本身最小化, 仅解析命令行参数, 调用lib/入口函数 - 如果出现了全局变量 一般意味着需要写一个 class/module 来放这个状态量了 -- 一个函数, 不要超过10行代码 +- 一个函数, 不要超过10行代码, 该原则适用于所有ruby/crystal/shell各类程序. - 起准确和有意义的变量/函数名字, 名字要让人看出赋予他们的确切意义 +- 函数要有分层结构. 每个函数须有明确的定位: 业务层逻辑, 还是底层支持性routine. + 一个函数不能同时做两个层次的事. 同一函数内避免混杂不同类型的事务. +- 如果注释仅仅是代码的简单重复, 不提供额外信息量, 不要写.

重构友好编码 ============