文档章节

代码风格

-鹏
 -鹏
发布于 2017/07/31 19:57
字数 839
阅读 25
收藏 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
杭州
前端工程师
私信 提问

暂无文章

zookeeper和HBASE总结

zookeeper快速上手 zookeeper的基本功能和应用场景 zookeeper的整体运行机制 zookeeper的数据存储机制 数据存储形式 zookeeper中对用户的数据采用kv形式存储 只是zk有点特别: key:是以路径...

瑞查德-Jack
46分钟前
1
0
Oracle 查询时间在当天的数据

要实现这个功能需要用到trunc这个函数对时间的操作select trunc(sysdate) from dual --2014-12-27 今天的日期为2014-12-27select trunc(sysdate, 'mm') from dual --2014-12-1 ......

覃光林
48分钟前
1
0
阿里技术专家详解 Dubbo 实践,演进及未来规划

作者:曹胜利 链接:https://www.infoq.cn/article/IwZCAp3jo_H5fJFbWOZu?utm_source=tuicool&utm_medium=referral Dubbo 整体介绍 Dubbo 是一款高性能,轻量级的 Java RPC 框架。虽然它是以...

Java干货分享
51分钟前
1
0
深入解读阿里云数据库POLARDB核心功能物理复制技术

日志是数据库的重要组成部份,按顺序以增量的方式记录了数据库上所有的操作,日志模块的设计对于数据库的可靠性、稳定性和性能都非常重要。 可靠性方面,在有一个数据文件的基础全量备份后,...

阿里云官方博客
55分钟前
1
0
Python数据科学环境:Anaconda 了解一下

几乎所有的 Python 学习者都遇到过“安装”方面的问题。这些安装问题包括 Python 自身环境的安装、第三方模块的安装、不同版本的切换,以及不同平台、版本间的兼容问题等。当你因为这些问题而...

crossin
56分钟前
1
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部