Различия между Do c комментариями и комментариями в Dart - PullRequest
0 голосов
/ 11 апреля 2020

Может быть, это кажется простым, но мне интересно узнать точные различия между Do c Comments и Comments в Dart.

/// это Do c Комментарий

// Это Комментарий

На мой взгляд, вопросы и ответы здесь могут быть полезны для и другие тоже:)

1 Ответ

1 голос
/ 11 апреля 2020

Комментарии (//)

Комментарии обычно используются для комментирования некоторой части вашего кода или добавления некоторых комментариев в ваш код, которые вы хотите сообщить своим товарищам по команде.

Do c Комментарии (///)

Do c Комментарий предназначен для целей документирования. Dartdo c анализирует c комментариев и создает страницы документации.

+--------------------------------------------+-----------------------------------------------------+
| Comments                                   | Doc Comments                                        |
+--------------------------------------------+-----------------------------------------------------+
|  - Comment out some part of your code      | - Anything that you want to document using dartdoc  |
|  - Private APIs                            | - Usually used for public API/Framework/Library     |
|  - Private variable declaration            |                                                     |
|  - Method implementation logic             |                                                     |
|  - Something you need to do in future      |                                                     |
|    for improvements or cleanup purpose etc |                                                     |
+--------------------------------------------+-----------------------------------------------------+

Подробнее об этом можно прочитать в Effective Dart - Documentation

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...