1c/v8-code-style
1
0
Fork 0
mirror of https://github.com/1C-Company/v8-code-style.git synced 2024-12-13 05:35:39 +02:00
Code Issues Releases Activity
1059cb64df
v8-code-style/bundles/com.e1c.v8codestyle.bsl/markdown/doc-comment-field-in-description-suggestion.md

512 B
Raw Blame History

Documentation comment multi-line description contains field definition

Noncompliant Code Example


// Parameters
//  Parameters - Structure - description
//  * Key1 - this field is part of description
Procedure NonComplaint(Parameters) Export
	// empty
EndProcedure

Compliant Solution


// Parameters:
//  Parameters - Structure - description:
//  * Key1 - Number - this field is extension of the structure
Procedure Complaint(Parameters) Export
	// empty
EndProcedure

See