How to use commnents in Dart code?
Open
Nobody has claimed this yet.
enhancement
good first issue
- Dominant language
- No language data
- Stars
- 45
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Description
Add a section in README to describe how to use comments in Dart code
- line comment with
// - block comment
/*...*/ - documentation comment with
///. Can be useful with dartdoc which is a tool to convert doc comment to html. Markdown format can be used in doc comment
ref: https://dart.dev/guides/language/effective-dart/documentation
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the repository README and review its existing structure and style. Add a section explaining Dart line comments, block comments, and documentation comments, including the dartdoc and Markdown references from the issue. Done means the README clearly covers all three forms and the referenced links remain usable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100