You've already forked v8-code-style
mirror of
https://github.com/1C-Company/v8-code-style.git
synced 2025-12-08 10:45:09 +02:00
42 lines
756 B
Markdown
42 lines
756 B
Markdown
|
# Documentation comment parameter section missed parameter definition
|
||
|
|
|
||
|
|
## Noncompliant Code Example
|
||
|
|
|
||
|
|
```bsl
|
||
|
|
// For export method all parameters should be in parameter section
|
||
|
|
//
|
||
|
|
// Parameters:
|
||
|
|
// Parameters - Only first parameter here
|
||
|
|
Procedure NonComplaint(Parameters, SecondParameter) Export
|
||
|
|
// empty
|
||
|
|
EndProcedure
|
||
|
|
|
||
|
|
// Parameters:
|
||
|
|
// Parameters - Method should not have parameter section
|
||
|
|
Procedure NonComplaint2() Export
|
||
|
|
// empty
|
||
|
|
EndProcedure
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
## Compliant Solution
|
||
|
|
|
||
|
|
```bsl
|
||
|
|
|
||
|
|
// Parameters:
|
||
|
|
// Parameters - Structure
|
||
|
|
Procedure Complaint(Parameters) Export
|
||
|
|
// empty
|
||
|
|
EndProcedure
|
||
|
|
|
||
|
|
// Parameters:
|
||
|
|
// Parameters - local methods may not contains all parameters
|
||
|
|
Procedure Complaint2(Parameters, SecondParameter)
|
||
|
|
// empty
|
||
|
|
EndProcedure
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
## See
|
||
|
|
|