Elements

graph TD; %% REQVIRE-AUTOGENERATED-DIAGRAM %% Graph styling classDef userRequirement fill:#D1C4E9,stroke:#7E57C2,stroke-width:2px; classDef systemRequirement fill:#E1D8EE,stroke:#673AB7,stroke-width:1.5px; classDef verification fill:#DCEDC8,stroke:#4CAF50,stroke-width:2px; classDef folder fill:#FAFAFA,stroke:#9E9E9E,stroke-width:3px; classDef file fill:#FFF8E1,stroke:#FFCA28,stroke-width:2px; classDef default fill:#F5F5F5,stroke:#424242,stroke-width:1.5px; subgraph 295862b78f71931e["📁 requirements/Functional/Integration"] subgraph 36a0666ce9e433d6["📄 Specifications.md"] e65459f80f414a8d["Comment Style Specification"]; class e65459f80f414a8d default; click e65459f80f414a8d "Specifications.html#comment-style-specification"; end end

Comment Style Specification

Comment syntax for code traceability markers by file extension.

Details

ExtensionComment StyleExample
.bat, .cmdREMREM [reqvire::satisfies: Req1] START
.py, .sh, .rb, .yml## [reqvire::satisfies: Req1] START
.sql---- [reqvire::satisfies: Req1] START
.css, .scss/* *//* [reqvire::satisfies: Req1] START */
.html, .xml, .xsl<!-- --><!-- [reqvire::satisfies: Req1] START -->
.c, .cpp, .cs, .java, .js, .ts, .rs//// [reqvire::satisfies: Req1] START

Metadata

  • type: specification

Relations