From 440ceb6f0d7bdcba73c65af4b92bb35c7579f889 Mon Sep 17 00:00:00 2001 From: Michael Tautschnig Date: Mon, 9 Jul 2018 21:45:45 +0100 Subject: [PATCH] Document proposed best practice for unused parameters --- CODING_STANDARD.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CODING_STANDARD.md b/CODING_STANDARD.md index 1b234d30628..871ff8a3f44 100644 --- a/CODING_STANDARD.md +++ b/CODING_STANDARD.md @@ -95,6 +95,9 @@ Formatting is enforced using clang-format. For more information about this, see # Naming - Identifiers may use the characters `[a-z0-9_]` and should start with a lower-case letter (parameters in constructors may start with `_`). +- Omit names of parameters or exception objects when they are not used. If + parameter names help documenting an interface, keep the name and use + `(void)parameter_name;` in the body of the method. - Use American spelling for identifiers. - Separate basic words by `_` - Avoid abbreviations (e.g. prefer `symbol_table` to `st`).