php:S1808 has confusing documentation

SonarQube
,
1

Running SonarQube 9.3 over PHP code and trying to configure php:S1808 - the parameter names are difficult to understand:

extends_implements_line
Default Value:
true
no_space_method_name
Default Value:
true
closure_format
Default Value:
true
space_comma
Default Value:
true
open_curly_brace_classes_functions
Default Value:
true
namespace_blank_line
Default Value:
true
open_curly_brace_control_structures
Default Value:
true

I managed to work through it by running through the window and the standard in parallel but it seems like more helpful descriptions, names, tooltips or a reference in the non-compliant and compliant code examples (such as: “this is ensured by open_curly_brace_control_structures set to true”) would be helpful.

1 Like
3

Hi @Adrianh,

Thanks for your input and sorry for the late reply. We agree that these properties are not necessarily self-explanatory. For this reason, with SonarQube 9.4, each property of this rule will have a short explanation.

Best,
Nils

4

Hello, Nils,

Thank you for the reply. Looking forward to the new version!

5

This topic was automatically closed 7 days after the last reply. New replies are no longer allowed.