这是什么javascript函数文档样式? //!@TheFunctionNameFunc

时间:2019-02-08 18:14:50

标签: javascript comments documentation-generation

我已经获得了一个网站,该网站在如下所示的javascript文件中使用代码文档和约定:

// !@TheFunctionNameFunc
function theFunctionNameFunc() {
    ...
}

其中每个示例唯一更改的是注释的“ FunctionName”部分-“ The”和“ Func”部分不仅是我为示例选择的,而且实际上是代码中的内容。我以为它可以送入doc自动生成器中并解释了这些约定,但是我什么也没看到。

有人以前曾经看过这个文档约定吗,或者知道它来自哪里?编码约定对我来说也有点不寻常,但是我可以将这些归类为个人喜好。 !@的评论虽然使我失望-它似乎太具体了,不能只是个人喜好。而且我不知道它会增加什么值,因为它只是重复该函数的名称而未提供任何其他信息,例如params或return值。我在网上浏览了一下,查看了JS文档工具和约定,找不到匹配项。

如果我对某种新的编码训练营趋势感到迷茫,或者只是奇怪,我会感到部分好奇。

0 个答案:

没有答案