HarmonyOS 鸿蒙Next中关于程序注释内容在调用时查看记录

HarmonyOS 鸿蒙Next中关于程序注释内容在调用时查看记录 很早之前，发现官方提供了代码DOC文档（程序注释）生成方法（https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-arktsdoc），主要是为了提供给开发者一种代码功能说明的工具。例如下图，提供了额外的说明文本，方便在调用（智能提示等）时，概要解释当前函数等的作用、使用方式等。

下面附上测试代码

@Entry
@Component
struct CSzhushi {
  @State message: string = 'Hello World';

  build() {
    RelativeContainer() {
      Text(this.message)
        .id('CSzhushiHelloWorld')
        .fontSize($r('app.float.page_text_font_size'))
        .fontWeight(FontWeight.Bold)
        .alignRules({
          center: { anchor: '__container__', align: VerticalAlign.Center },
          middle: { anchor: '__container__', align: HorizontalAlign.Center }
        })
        .onClick(() => {
          this.message = 'Welcome';
        })
    }
    .height('100%')
    .width('100%')
  }
}

function cd(){
  let l:cslei = new cslei(1,2);
  l.csfangfa(3);
  let k:csjiekou = {
    k1: 0,
    k2: 0
  }
}


/**
 * 这是测试类
 */
class cslei{
  /**
   *测试类构造函数
   * @param l参数一
   * @param l2参数二
   */
  constructor(l:number,l2:number) {

  }

  /**
   * 测试类的测试方法
   * @param k，参数一
   */
  csfangfa(k:number){

  }
}

/**
 * 这是测试接口
 * @param k2,接口属性二
 */
interface csjiekou{
  /**
   * 接口属性一
   */
  k1:number,
  k2:number
}

在调用时，可以在提示框中快速查看函数等说明，使用不同的标记、在不同的地方注释，会在对应情况进行显示，详细操作参考官方问文档（https://developer.huawei.com/consumer/cn/doc/harmonyos-guides/ide-arktsdoc）

示例：

1.类注释

显示：

类之前注释，这在作为类型时显示

方法之前注释，则在调用时进行显示

2.接口注释

显示：

这种方式，对于文件之间引用很复杂的情况特别有用，不需要定位到代码源位置，即可了解当前调用对象的作用说明。

小技巧：建议在代码写完后再去注释，这样会自动填充一部分内容，减少注释工作量。