diff options
Diffstat (limited to 'src/doc/rust-by-example/src/attribute/unused.md')
-rw-r--r-- | src/doc/rust-by-example/src/attribute/unused.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/src/doc/rust-by-example/src/attribute/unused.md b/src/doc/rust-by-example/src/attribute/unused.md new file mode 100644 index 000000000..1eab37480 --- /dev/null +++ b/src/doc/rust-by-example/src/attribute/unused.md @@ -0,0 +1,26 @@ +# `dead_code` + +The compiler provides a `dead_code` +[*lint*][lint] that will warn +about unused functions. An *attribute* can be used to disable the lint. + +```rust,editable +fn used_function() {} + +// `#[allow(dead_code)]` is an attribute that disables the `dead_code` lint +#[allow(dead_code)] +fn unused_function() {} + +fn noisy_unused_function() {} +// FIXME ^ Add an attribute to suppress the warning + +fn main() { + used_function(); +} +``` + +Note that in real programs, you should eliminate dead code. In these examples +we'll allow dead code in some places because of the interactive nature of the +examples. + +[lint]: https://en.wikipedia.org/wiki/Lint_%28software%29 |