Flutter | 优雅的注释

写一个简单例子给你们感受下。

在 Android Studio 中定义下面一个方法：

/// 构建person信息字符串
///
/// idNumber: 身份证号
/// name: 姓名
/// age: 年龄
/// address: 地址
String buildPersonInfoString({
    
    
  required int idNumber,
  required String name,
  required int age,
  required String address,
}) {
    
    
  return 'xxx';
}

鼠标放到方法名上，弹出文档：

现在我把注释稍微改一下：

/// 构建person信息字符串
///
/// - [idNumber]: 身份证号
/// - [name]: 姓名
/// - [age]: 年龄
/// - [address]: 地址
String buildPersonInfoString({
    
    
  required int idNumber,
  required String name,
  required int age,
  required String address,
}) {
    
    
  return 'xxx';
}

鼠标放到方法名上：

第二种注释增加了换行和高亮，在描述和参数比较多的时候，可读性明显比第一种注释好。