i5ting / i5ting/How-to-write-jQuery-plugin

书写规范 统一的标点符号和英文留白等

Open
#1 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
16
Forks
7
PR merge metrics
No merged PRs in 30d

Description

既然是写一个教程,不妨做规范一些,
## 英文留白、标点符号及 Inline Code

> 这个插件的特点是它前面必须是选择器,那么就可以是一个也可以多个,因为选择器有很多种,选择器返回的是数组,比如例子中的.mytab,在一个html文档里可以有多个

这里 `.mytab` 既然是代码里面的引用,那最好做成 inline code,英文和中文最好用空格格开。

> 在一个 html 文档里可以有多个
>
> jQuery的哲学是“write less,do more”,它做到了么?

这句中,英文标点 `,` 和中文标点 `,` 混合使用,最好统一。
## 名词统一

文本有时提到 jQuery 时有时全用了小写 jquery,最好统一。
## 中文避免使用斜体

> **_不严谨是写代码的大忌**_

中文的斜体并不好看,觉得加粗就能够表达强调的意思了,没有必要斜体。

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.