1
0
mirror of https://github.com/1C-Company/v8-code-style.git synced 2025-12-07 18:33:13 +02:00
Files
v8-code-style/bundles/com.e1c.v8codestyle.bsl/markdown/doc-comment-parameter-section.md

756 B

Documentation comment parameter section missed parameter definition

Noncompliant Code Example

// 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


// 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