文档章节

代码风格

-鹏
 -鹏
发布于 2017/07/31 19:57
字数 839
阅读 23
收藏 0

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

© 著作权归作者所有

共有 人打赏支持
上一篇: 破解软件
-鹏

-鹏

粉丝 20
博文 155
码字总数 92388
作品 0
杭州
前端工程师
私信 提问

暂无文章

降压变换器 Buck

特点 输入输出极性相同。 工作过程 在 MOS 导通时,输入电源通过 L 和 C 滤波后向负载端提供电流;当 MOS 断开后,L 通过二极管续流,保持负载电流连续。输出电压因为占空比的作用,不会超过...

colinux
今天
1
0
Apache日志不记录访问静态文件,访问日志切割,静态元素过期时间设置

Apache配置不记录访问静态文件的日志 网站大多元素为静态文件,如图片、css、js等,这些元素可以不用记录 vhost原始配置 <VirtualHost *:80> ServerAdmin test@163.com DocumentRoo...

野雪球
今天
3
0
聊聊storm的ICommitterTridentSpout

序 本文主要研究一下storm的ICommitterTridentSpout ICommitterTridentSpout storm-core-1.2.2-sources.jar!/org/apache/storm/trident/spout/ICommitterTridentSpout.java public interface......

go4it
今天
4
0
Ubuntu常用操作

查看端口号 netstat -anp |grep 端口号 查看已使用端口情况 netstat -nultp(此处不用加端口号) netstat -anp |grep 82查看82端口的使用情况 查找被占用的端口: netstat -tln netstat -tl...

hc321
昨天
3
0
网站cdn的静态资源突然访问变的缓慢,问题排查流程

1.首先我查看了一下是否自己的网络问题,通过对比其他资源的访问速度和下载速度,确认不是 2.通过ping 和 tracert 判断cdn域名能否正常访问,(最后回想感觉这一步可以省略,因为每次最终能访...

小海bug
昨天
3
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部