https://github.com/taylorpzreal/codestyle-codereview

Code style and code review collections.
https://github.com/taylorpzreal/codestyle-codereview

code-review code-style

Last synced: 4 months ago
JSON representation

Code style and code review collections.

• Host: GitHub
• URL: https://github.com/taylorpzreal/codestyle-codereview
• Owner: TaylorPzreal
• License: mit
• Created: 2017-12-01T03:50:16.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-12-01T07:18:26.000Z (over 8 years ago)
• Last Synced: 2025-09-04T05:03:25.274Z (10 months ago)
• Topics: code-review, code-style
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Code style - code review

> Code style and code review collections.

## Code style

- [JavaScript](./javascript)

- [TypeScript](./typescript)

- [HTML](./html)

- [SCSS](./scss)

- [CSS](./css)

- [angular](./angular)

## Code review

- code review

## Basic code style

- 编码都是utf-8

- 缩进2个空格

- 时常 format code

- ts，js，css都是单引号

- 函数不要过长

- 函数单一功能

- 一个文件不要过长，一般不要多过400行

- 多写注释 （插件Document This）

- 变量命名，不要用简写的拼音

## 自动化代码规范

> 详细配置文件查看 [lint-config](./lint-config)

- 编辑器 visual studio code

- 规范插件

  - ESLint

  - HTMLHint

  - Sass Lint

  - TSLint

  - markdownlint

- 格式化插件

  - Prettier - Code formatter

  - Beautify

- 配置插件

  - EditorConfig for VS Code