文档书写中和用法上的区别

我们在看文档的时候,有时候会遇到这样的写法:

axios#request(config)
// 摘自axios文档 https://github.com/axios/axios

第一次看到这种写法的时候我很困惑,我觉得这一定是写错了:一般不都是用.表示调用吗? 他怎么用#表示呢?
后来读的文档多了,我发现这种用法还比较常见。他是用于区别.的一种写法,表示不同的调用方式。就axios文档来说他的区别是这样的:

axios.create([config])

表示调用axios这个类上的静态方法create

axios#request(config)

表示调用axios实例上的方法request

需要注意的是,这种写法表达的意思也不固定,只是在需要区分的时候才这么写。比如一篇文档通篇都是调用实例上的方法,那么都写成: instance_name.function_name也是没有问题的。

评论

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

这个站点使用 Akismet 来减少垃圾评论。了解你的评论数据如何被处理