2023-05-03 11:06:20 +02:00
== Why is this an issue?
2020-06-30 10:16:44 +02:00
A long parameter list can indicate that a new structure should be created to wrap the numerous parameters or that the procedure is doing too many things.
2023-05-03 11:06:20 +02:00
=== Noncompliant code example
2020-06-30 10:16:44 +02:00
With a maximum number of 3 parameters:
2020-06-30 14:49:38 +02:00
2022-02-04 17:28:24 +01:00
[source,vbnet]
2020-06-30 10:16:44 +02:00
----
Public Sub Foo(ByVal p1 As Integer, ByVal p2 As Integer, ByVal p3 As Integer, ByVal p4 As Integer) ' Noncompliant
' ...
End Sub
Public Function Bar(ByVal p1 As Integer, ByVal p2 As Integer, ByVal p3 As Integer, ByVal p4 As Integer) ' Noncompliant
' ...
End Function
----
2023-05-03 11:06:20 +02:00
=== Compliant solution
2020-06-30 10:16:44 +02:00
2022-02-04 17:28:24 +01:00
[source,vbnet]
2020-06-30 10:16:44 +02:00
----
Public Sub Foo(ByVal p1 As Integer, ByVal p2 As Integer, ByVal p3 As Integer)
' ...
End Sub
Public Function Bar(ByVal p1 As Integer, ByVal p2 As Integer, ByVal p3 As Integer)
' ...
End Function
----
2021-06-02 20:44:38 +02:00
2023-05-03 11:06:20 +02:00
=== Exceptions
2022-02-18 14:15:34 +01:00
[source,vbnet]
----
Public Class BaseClass
2022-02-18 15:03:19 +01:00
Public Sub New(Param1 As Integer)
' ...
End Sub
2022-02-18 14:15:34 +01:00
End Class
2022-02-18 15:03:19 +01:00
Public Class DerivedClass
Inherits BaseClass
2022-02-18 14:15:34 +01:00
2022-02-18 15:03:19 +01:00
Public Sub New(Param1 As Integer, Param2 As Integer, Param3 As Integer, Param4 As Integer, Param5 As Long)
MyBase.New(Param1) ' Compliant, the parameters intended for the base class constructor do not count in the sum of the parameter list.
' ...
End Sub
2022-02-18 14:15:34 +01:00
End Class
----
2021-06-03 09:05:38 +02:00
ifdef::env-github,rspecator-view[]
2021-09-20 15:38:42 +02:00
'''
== Implementation Specification
(visible only on this page)
2023-05-25 14:18:12 +02:00
=== Message
[Constructor|Function|Sub|Delegate|Lambda] has {0} parameters, which is greater than the {1} authorized.
2021-09-20 15:38:42 +02:00
include::../parameters.adoc[]
2021-06-08 15:52:13 +02:00
'''
2021-06-02 20:44:38 +02:00
== Comments And Links
(visible only on this page)
include::../comments-and-links.adoc[]
2023-06-22 10:38:01 +02:00
2021-06-03 09:05:38 +02:00
endif::env-github,rspecator-view[]