代码风格
博客专区 > -鹏 的博客 > 博客详情
代码风格
-鹏 发表于4个月前
代码风格
  • 发表于 4个月前
  • 阅读 19
  • 收藏 0
  • 点赞 0
  • 评论 0

腾讯云 新注册用户 域名抢购1元起>>>   

摘要: 代码风格三个层次。整洁的代码,清晰的代码,优雅的代码。

see also: [How to write elegant code?](https://my.oschina.net/wanjubang/blog/675953)

[How to write elegant code?(Part 2)](https://my.oschina.net/wanjubang/blog/703907)

 

整洁的代码

1. 代码格式

这真的是个老生长谈的问题 。有的人通过软约定来实现项目代码格式统一,有的人通过配置(如eslint)来实现代码格式统一。 我个人更倾向于自动格式化实现项目代码格式统一,项目的格式就是一个配置,但却不要求开发人员必须遵守,代码特定时候(保存或者提交或者手动触发)自动格式化。比较有名的插件有beautify ,prettier。

 

2. 模块划分

    函数因子划分,用了react等组件化框架的话还有组件划分。组件和函数的基本原则是单一职责,即一个模块只做一件事。一般来说一个函数代码不宜超过100行,一个组件代码不宜超过300行。

see also : https://my.oschina.net/wanjubang/blog/704162

3. 命名

    减少命名!实在不行的话要采取合适的命名,即具体不模糊不清,通俗易懂。如果你实在想不出名字,那么只好麻烦你写好注释(良好的代码应该是自注释的)了。

为什么我们需要给命名呢?大部分人答案是,因为需要变量或者常量来保存数据。 如果你是抱着保存数据,供其他方法使用,那么我觉得不可没必要。其实函数也是一种对象,我们大可以通过合理的组装这些函数形成一个新的函数,然后将数据丢给新函数,它就会乖乖吐出我们想要的东西。

 

一个例子:

git log > git.log

这段代码就是通过git 命名查找当前仓库日志并写入git.log文件。非常简单,试想让你通过代码实现,是不是会先保存 log数据,然后再写入呢?

 

清晰的代码

1. 格式

函数的书写应该遵守一定的格式。 就像写文章一样,总有一些套路。 还记得上初中老师叫我们写作的套路,什么总分总,什么首尾呼应,画龙点睛。 写代码也是一样,遵守一定的格式也很重要。

个人比较喜欢的格式:

# 变量声明

# 入参验证, 执行分支逻辑

# 函数组合,将多个函数组合成一个新函数

# 执行函数。 其实就是数据在函数中流动

# 返回。一个函数如果没有返回值,我怎么知道它执行了没有。

2. 参数约定

一定能够通过函数签名或者段注释看出你的入参和出参。良好的代码甚至应该在必要的时候增加一些例子。

如果你说明你的代码能干什么,我还以为什么都能干呢。如果函数不定义明确的输出,我还以为总会给我正确的结果呢? 如果函数突然抛出一个错误,这会弄脏你的手。

参考:

https://my.oschina.net/wanjubang/blog/675953  (putting the ret into bottle)

https://my.oschina.net/wanjubang/blog/744438(4.注释方面)

 

优雅的代码

see : https://my.oschina.net/wanjubang/blog/1494254

共有 人打赏支持
粉丝 18
博文 142
码字总数 91236
×
-鹏
如果觉得我的文章对您有用,请随意打赏。您的支持将鼓励我继续创作!
* 金额(元)
¥1 ¥5 ¥10 ¥20 其他金额
打赏人
留言
* 支付类型
微信扫码支付
打赏金额:
已支付成功
打赏金额: