如何用javascript编写文档？

Question

这是我在controller.js文件中的代码

private void fetchData(DataSnapshot dataSnapshot)
{

    for (DataSnapshot ds : dataSnapshot.getChildren())
    {
        Userdetail userdetail =ds.getValue(Userdetail.class);
        userdetails.add(userdetail );
    }
}

我在日食中工作。

代码，就像现在一样......执行以下操作

我把光标放在getSelectedClassParam上面 然后弹出一个黄色矩形并显示该类的描述......描述如下：

但我需要像这样的东西：

有什么想法吗？

Answer 1

不确定但可能尝试在Eclipse中使用自动格式化程序？

Eclipse中的自动格式： Ctrl + Shift + F

Eclipse - Key bindings

Answer 2

尝试声明这样的功能：

function foo(bar){
   return bar;
};

Eclipse就是为声明生成文档！用于声明函数的赋值表达式与x=1;之类的表达式没有区别，Eclipse不会为表达式生成文档。

我建议您查看this question。它解释了函数声明的差异。

Answer 3

这是重复：

Does JavaScript have a standard for commenting functions?

我认为最接近标准的是JSDoc。 http://usejsdoc.org