Skip to content

Commit

Permalink
update code comment style (tikv#8325)
Browse files Browse the repository at this point in the history
Signed-off-by: Calvin Weng <[email protected]>

Co-authored-by: winkyao <[email protected]>
  • Loading branch information
dcalvin and winkyao authored Oct 20, 2020
1 parent 482bd12 commit 6bccdff
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion CODE_COMMENT_STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,14 +99,24 @@ A comment is generally used for:
- Open the file (Wrong)

- Use "this" instead of "the" to refer to the current thing.

- Gets the toolkit for this component (Recommended)
- Gets the toolkit for the component (Not recommended)

- The Markdown format is allowed.

- Opens the `log` file

### Taboos in comments

The Code Comment Style defined in this document follows the [CNCF Code of Conduct](https://github.com/tikv/tikv/blob/master/CODE_COMMENT_STYLE.md). The following language uses are deemed as taboos and are not acceptable in code comments:

- Sexualized language
- Racial or political allusions
- Public or private harassment
- Language that contains private information, such as a physical or electronic address, without explicit permission
- Other inapproiate uses

### Tips for a good comment

- Comment code while writing it.
Expand Down

0 comments on commit 6bccdff

Please sign in to comment.