资讯专栏INFORMATION COLUMN

怎样给文件命名才能显得更加专业

toddmark / 1308人阅读

摘要:前言写这篇博客的动机很简单,就是我周末闲的无聊,爬了上数前的项目的所有文件的名称,看看大佬们都喜欢给文件和目录取什么名字,我跟着学两招也好显得我比较专业。统计结果排除掉了,,这类文件,得到了个文件名。

前言

写这篇博客的动机很简单,就是我周末闲的无聊,爬了github上star数前1000的js项目的所有文件的名称,看看大佬们都喜欢给文件和目录取什么名字,我跟着学两招也好显得我比较专业。

注意是js项目啊,你要是搞java的搞PHP的,也跟着学搞不好会被拿去祭天。

统计结果

排除掉了.babelrcpackage.json.github这类文件,得到了93117个文件名。

然后我对文件名计数,同一个项目中多次出现的名称只计算一次。也就是1000个项目中,出现频次最高的名称也不会超过1000。

结果这里写不下,可以点击这里看所有结果,我画了个图大家感受一下就行了

有点意外,出现次数最多的是test,565次,其次才是是src,556次

顾名思义,src是源代码,test就是测试,同样jscssimg这些目录名都很直观。

但是也有一些不太直观的名字在这些项目中也大量出现,比如legacybenchmarksfixtures等等。

常用名称

下面列出了一些常用的名称,并不是按出现频次排序,但是列出来的都是出现频次非常高的
单复数形式都出现了的只列出次数最多的
注意,都是目录名称,不是文件名

src,source

源代码,用src居多

test,__tests__

测试文件,也经常用__test__,facebook的测试框架jest默认的测试文件目录就是__test__

docs

文档

lib

库文件,library的缩写

dist

用来放打包编译后的文件,应该是distribution的缩写

build,scripts

构建脚本

utils,tools,helpers

工具代码

controllers,views,middlewares,models

MVC对应的models,views,controllers,还有中间件middlewares

router

路由

server

用来放服务端代码

adapters

适配器,适配器模式是一种很常用的设计模式
栗子:https://github.com/hubotio/hu...

legacy

一般用来放兼容历史版本或兼容旧浏览器的代码
栗子:https://github.com/julianshap...

config

配置文件

benchmarks

benchmarks测试,又叫基准测试或性能测试。用来测试版本的性能变化

unit,spec

单元测试,一般在test目录下

e2e

端对端测试,一般在test目录下

assets,vendor

资源,一般用来放图片或css文件

static

静态资源

examples,demo

示例

component

组件

plugins

插件

bin

命令脚本,命令行工具经常会用到
栗子:https://github.com/vuejs/vue-...

common

公用的文件

packages

很多项目会打包出多个npm包,用来减小体积,一般会用packages来放不同的包
栗子:https://github.com/babel/babe...

misc

杂项,miscellaneous的缩写
栗子:https://github.com/babel/babe...

core

核心文件
栗子:https://github.com/mrdoob/thr...

还有一大堆,总共500多个,我不一一解释了,有兴趣可以点击看统计结果

后话

其实大部分文件名看名字就能知道意思,也有一些是约定俗成的缩写。
相比之下更有意义的是对变量和函数名称的分析,我下次把这些项目的所有js文件内容爬下来然后再做一个分析。

打个广告:

我的博客 https://github.com/hujiulong/...

欢迎star

文章版权归作者所有,未经允许请勿转载,若此文章存在违规行为,您可以联系管理员删除。

转载请注明本文地址:https://www.ucloud.cn/yun/92925.html

相关文章

  • 怎样找到当前页面发布日期的几种方法

    摘要:因此,我接下来要以知乎的某个文章有哪些高级笑话只有具备了一定的专业知识才能听懂我这里暂时不想去深究为啥知乎不公开提问日期作为主要示例介绍一下如何能够找到网上的任何页面的发布日期的几种方法了。 前言 为什么要搞清楚该网页内容的发布时间呢,有些网站作者的确很不友好,故意隐藏,目的是啥我也不知道。但是我觉得有时候的确很有必要知道正在查阅的内容,尤其是相对重要的内容的时候,他的发布日期对我来说...

    TerryCai 评论0 收藏0
  • 后端好书阅读与推荐(续二)

    摘要:后端好书阅读与推荐系列文章后端好书阅读与推荐后端好书阅读与推荐续后端好书阅读与推荐续二几个月又过去了,又读了几本书,同时为了深切体会到某些书里面的要点还专门做了一个小项目,这里就把读书与小项目过程中的一些心得体会记录一下。 后端好书阅读与推荐系列文章:后端好书阅读与推荐后端好书阅读与推荐(续)后端好书阅读与推荐(续二) 几个月又过去了,又读了几本书,同时为了深切体会到某些书里面的要点还...

    Jioby 评论0 收藏0
  • 后端好书阅读与推荐(续二)

    摘要:后端好书阅读与推荐系列文章后端好书阅读与推荐后端好书阅读与推荐续后端好书阅读与推荐续二几个月又过去了,又读了几本书,同时为了深切体会到某些书里面的要点还专门做了一个小项目,这里就把读书与小项目过程中的一些心得体会记录一下。 后端好书阅读与推荐系列文章:后端好书阅读与推荐后端好书阅读与推荐(续)后端好书阅读与推荐(续二) 几个月又过去了,又读了几本书,同时为了深切体会到某些书里面的要点还...

    CompileYouth 评论0 收藏0

发表评论

0条评论

最新活动
阅读需要支付1元查看
<