Warning: file_get_contents(/data/phpspider/zhask/data//catemap/1/angular/32.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181

Warning: file_get_contents(/data/phpspider/zhask/data//catemap/3/sockets/2.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Angular或JavaScript中的@license和@publicApi内部注释是什么_Javascript_Angular_Comments - Fatal编程技术网

Angular或JavaScript中的@license和@publicApi内部注释是什么

Angular或JavaScript中的@license和@publicApi内部注释是什么,javascript,angular,comments,Javascript,Angular,Comments,我构建了我的Angular应用程序,然后查看了构建的代码,我在其中找到了@license或@publicApi的内部注释,如下图所示。我不知道这是什么,也不知道如何创造它们。如果有人知道,请在下面评论你的答案,这将有助于我了解一些新的东西 这是谷歌使用的jsDoc注释。这是一个很好的写作指南: 例如,@许可证可以解释为: 公共api似乎是谷歌特有的。所有这些都是注释。它们不会改变代码的工作方式 JSDoc的目的是记录JavaScript应用程序或库的API。假设您需要记录模块、名称空间、类、方法

我构建了我的Angular应用程序,然后查看了构建的代码,我在其中找到了@license或@publicApi的内部注释,如下图所示。我不知道这是什么,也不知道如何创造它们。如果有人知道,请在下面评论你的答案,这将有助于我了解一些新的东西


这是谷歌使用的jsDoc注释。这是一个很好的写作指南:

例如,@许可证可以解释为:

公共api似乎是谷歌特有的。所有这些都是注释。它们不会改变代码的工作方式


JSDoc的目的是记录JavaScript应用程序或库的API。假设您需要记录模块、名称空间、类、方法、方法参数等内容。

用于生成文档的标记,它们与Angular无关,但当我添加标记时,它不会变得丰富多彩。它将是绿色的,就像注释中的其他文本一样。那么我们如何才能创建这些注释呢?请检查,或者您可以使用/**注释手动添加它们。正如您在屏幕截图中看到的,@something是彩色的,但每当我手动添加它时,它就会像普通注释一样变为绿色。Jsdoc需要采用特定的格式。将整个部分从angular复制并粘贴到代码中,看看会发生什么。或者最好转到您的函数,在上面键入/**并按enter键。理想情况下,在每个类和公共方法/成员定义上。我在私有方法上添加了它们,以供将来参考。
 The @license tag identifies the software license that applies to any portion of your code.

 You can use any text to identify the license you are using.