Skip to content

Commit

Permalink
[move-book] Added block doc comment option
Browse files Browse the repository at this point in the history
Move seems to support block doc comments /** */.

It seems that the document does not make style recommendations on the
comment style, therefore listing all the possible comment options here.

Closes: diem#125
  • Loading branch information
villesundell authored and bors-diem committed Mar 21, 2022
1 parent 27eed8e commit 0794df8
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion language/documentation/book/src/coding-conventions.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ module 0x1::Importer {
## Comments

- Each module, struct, and public function declaration should be commented
- Move has both doc comments `///`, regular single-line comments `//`, and block comments `/* */`
- Move has doc comments `///`, regular single-line comments `//`, block comments `/* */`, and block doc comments `/** */`

## Formatting

Expand Down

0 comments on commit 0794df8

Please sign in to comment.