5

我的代码包含许多用多行注释语法编写的文档注释，例如示例

/** 
 * This class is used as an example.
 *
 * To ask about multiline comments.
 */
class A {
}

/**
 * Another example class with comment.
 */
class B {
}

有时，在调试/重构或试验代码期间，我想注释掉一些代码块。在这个例子中，我想注释掉类A和B. 有没有办法以一种简单的方式做到这一点，而无需查看文档注释的开始和结束位置，也无需使用一行注释语法分别注释每一行//？

4

2 回答 2

9

Dart（与其他类似 C 的语法语言相反）本机支持嵌套的多行注释。

所以你可以写

/* Commented for debugging purposes!!! Do not forget to uncomment!!!
/** 
 * This class is used as an example.
 *
 * To ask about multiline comments.
 */
class A {
}

/**
 * Another example class with comment.
 */
class B {
}
*/

并且不关心评论块内的一些嵌套评论。

于 2013-09-09T07:31:58.103 回答
0

多行注释以/*(正斜杠) 开始，以*/(星号) 结束。如上所述@samuel 回答

但有时，您需要标记部分代码以供将来参考：优化和改进的领域、可能的更改、要讨论的问题等等。sp 您添加特殊类型的注释，这些注释在编辑器中突出显示并编入索引。这样，您和您的队友就可以跟踪需要注意的问题。

这是一个例子

import 'package:analyzer/error/error.dart';

/**
 * The error code indicating a marker in code for work that needs to be finished
 * or revisited.
 */
class TodoCode extends ErrorCode {
  /**
   * The single enum of TodoCode.
   */
  static const TodoCode TODO = TodoCode('TODO');
  /**
   * This matches the two common Dart task styles
   *
   * * TODO:
   * * TODO(username):
   *
   * As well as
   * * TODO
   *
   * But not
   * * todo
   * * TODOS
   */
  static RegExp TODO_REGEX =
      RegExp("([\\s/\\*])((TODO[^\\w\\d][^\\r\\n]*)|(TODO:?\$))");
  /**
   * Initialize a newly created error code to have the given [name].
   */
  const TodoCode(String name)
      : super(
          message: "{0}",
          name: name,
          uniqueName: 'TodoCode.$name',
        );
  @override
  ErrorSeverity get errorSeverity => ErrorSeverity.INFO;
  @override
  ErrorType get type => ErrorType.TODO;
}

也可以做文档评论

///文档注释是以 或 开头的多行或单行注释/**。在连续行上使用///与多行文档注释具有相同的效果。

于 2022-01-29T03:01:11.673 回答