onflow/cadence-tools

[Lint] Suggest appropriate comment style in .cdc files

Opened this issue · 0 comments

Description

Linter should inform users that

  1. Top level comments and comments for types, fields, events, and functions should use /// which will ensure it gets picked up by the Cadence doc autogeneration
  2. Regular comments within functions should only use two slashes