From 76017ec67f1232a94fe59f7baf15ddc00ba8ba9a Mon Sep 17 00:00:00 2001 From: Shiqing Gao Date: Fri, 30 Oct 2020 15:30:47 +0800 Subject: [PATCH] doc: update coding guidelines - add a rule for function parameter limit Signed-off-by: Shiqing Gao --- doc/developer-guides/c_coding_guidelines.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/doc/developer-guides/c_coding_guidelines.rst b/doc/developer-guides/c_coding_guidelines.rst index a665f9056..964b87f89 100644 --- a/doc/developer-guides/c_coding_guidelines.rst +++ b/doc/developer-guides/c_coding_guidelines.rst @@ -1079,6 +1079,26 @@ Compliant example:: } +C-FN-20: Each function shall have at most 6 parameters +====================================================== + +Compliant example:: + + void func_showcase(uint32_t param_1, uint32_t param_2, uint32_t param_3, + uint32_t param_4, uint32_t param_5, uint32_t param_6) { + ... + } + +.. rst-class:: non-compliant-code + + Non-compliant example:: + + void func_showcase(uint32_t param_1, uint32_t param_2, uint32_t param_3, + uint32_t param_4, uint32_t param_5, uint32_t param_6, + uint32_t param_7) { + ... + } + Statements **********