Javascript 文档标准
Javascript documentation standards
我有一个问题,我已经尝试研究了,也许我用错了词。
问题:是否有类似于
的专业预期风格来记录您的javascript文件、函数等
/**
* Method that sum's x + 5
* @param x
*/
public void sum(int x)
{
//code (x + 5)
}
抱歉,如果这是一个不好的例子!但我希望我的问题有意义
据我所知,没有一个标准。然而,使用 /** 开始一个块来解释函数的 C 标准仍然是一个很好用的标准。这允许扫描代码以查找 function/method 描述符的程序轻松找到它。它还使程序员更容易,因为切换语言不需要切换注释样式。
我有一个问题,我已经尝试研究了,也许我用错了词。
问题:是否有类似于
的专业预期风格来记录您的javascript文件、函数等/**
* Method that sum's x + 5
* @param x
*/
public void sum(int x)
{
//code (x + 5)
}
抱歉,如果这是一个不好的例子!但我希望我的问题有意义
据我所知,没有一个标准。然而,使用 /** 开始一个块来解释函数的 C 标准仍然是一个很好用的标准。这允许扫描代码以查找 function/method 描述符的程序轻松找到它。它还使程序员更容易,因为切换语言不需要切换注释样式。