dwyl/learn-dart

How to use commnents in Dart code?

Open

#5 opened on Jan 15, 2020

View on GitHub
 (0 comments) (1 reaction) (0 assignees) (10 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (44 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Tech stack
Domain
Issue type
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Prerequisites
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.