1c/v8-code-style
1
0
Fork 0
mirror of https://github.com/1C-Company/v8-code-style.git synced 2024-12-13 13:48:40 +02:00
Code Issues Releases Activity
5bdea17378
v8-code-style/bundles/com.e1c.v8codestyle.bsl/markdown/doc-comment-parameter-in-description-suggestion.md

475 B
Raw Blame History

Documentation comment multi-line description contains parameter definition

Noncompliant Code Example

// Description
// 
// Parameters
//  Parameter1 - this parameter is part of description
Procedure NonComplaint(Parameter1) Export
	// empty
EndProcedure

Compliant Solution

// Description
// 
// Parameters:
//  Parameter1 - this parameter is the section of parameters
Procedure Complaint(Parameters) Export
	// empty
EndProcedure

See