We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 435095f commit 9ec051dCopy full SHA for 9ec051d
src/doc/style/style/comments.md
@@ -1,4 +1,4 @@
1
-% Comments [FIXME: needs RFC]
+% Comments [RFC #505]
2
3
### Avoid block comments.
4
@@ -74,7 +74,25 @@ For example:
74
75
### Code snippets
76
77
-> **[FIXME]**
+Only use inner doc comments `//!` to write crate and module-level documentation,
78
+nothing else. When using `mod` blocks, prefer `///` outside of the block:
79
+
80
+```rust
81
+/// This module contains tests
82
+mod test {
83
+ // ...
84
+}
85
+```
86
87
+over
88
89
90
91
+ //! This module contains tests
92
93
94
95
96
97
### Avoid inner doc comments.
98
0 commit comments