mirror of
https://github.com/1C-Company/v8-code-style.git
synced 2024-12-13 05:35:39 +02:00
918 B
918 B
Use only hyphen-minus in documentation comment
In Description of Documentation comment model should use only hyphen-minus symbol instead of usual hyphen or different dashes.
This check analyze wrong "minus" only in first text part of description which goes after field declaration to catch possible wrong parsing of the documentation comment model.
Noncompliant Code Example
// Parameters:
// Parameters – Structure - first is middle-dash and second is minus:
// * Key1 - Number ⸺ incorrect long dash
Procedure NonComplaint(Parameters) Export
// empty
EndProcedure
Compliant Solution
// Parameters:
// Parameters - Structure - both are minus:
// * Key1 - Number - used correct minus
Procedure Complaint(Parameters) Export
// empty
EndProcedure