16f6c0aecf
Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in.
50 lines
913 B
Plaintext
50 lines
913 B
Plaintext
== Why is this an issue?
|
|
|
|
Naming the parameters in a function prototype helps identify how they'll be used by the function, thereby acting as a thin layer of documentation for the function.
|
|
|
|
|
|
=== Noncompliant code example
|
|
|
|
[source,cpp]
|
|
----
|
|
void divide (int, int);
|
|
----
|
|
|
|
|
|
=== Compliant solution
|
|
|
|
[source,cpp]
|
|
----
|
|
void divide (int numerator, int denominator);
|
|
----
|
|
|
|
|
|
== Resources
|
|
|
|
* MISRA C:2004, 16.3 - Identifiers shall be given for all of the parameters in a function prototype declaration
|
|
* MISRA C:2012, 8.2 - Function types shall be in prototype form with named parameters
|
|
|
|
|
|
ifdef::env-github,rspecator-view[]
|
|
|
|
'''
|
|
== Implementation Specification
|
|
(visible only on this page)
|
|
|
|
=== Message
|
|
|
|
Give names to the parameters of this function prototype.
|
|
|
|
|
|
'''
|
|
== Comments And Links
|
|
(visible only on this page)
|
|
|
|
=== relates to: S819
|
|
|
|
=== relates to: S927
|
|
|
|
=== is related to: S829
|
|
|
|
endif::env-github,rspecator-view[]
|