diff --git a/style-guide/README.md b/style-guide/README.md index 9e6888cb6..adb73a7ee 100644 --- a/style-guide/README.md +++ b/style-guide/README.md @@ -121,10 +121,10 @@ smaller: #### Doc comments -Prefer line comments (`///`) to block comments (`//* ... */`). +Prefer line comments (`///`) to block comments (`/** ... */`). -Prefer outer doc comments (`///` or `//*`), only use inner doc comments (`//!` -and `//*!`) to write module-level or crate-level documentation. +Prefer outer doc comments (`///` or `/** ... */`), only use inner doc comments +(`//!` and `/*! ... */`) to write module-level or crate-level documentation. Doc comments should come before attributes.