JavaScript有评论function的标准吗？
我目前正在写一些客户端JavaScript代码，并想知道如何评论我的function。
我来自一个C＃背景，在那里有一个由我遵循的Microsoftlogging的官方build议的评论风格，它允许编译器和其他工具自动生成文档。
类似地，PHP的PHPDoc风格无处不在，并正在成为PHP推荐的官方标准 。
JavaScript是否同样具有普遍接受的工具链，标准或一组最佳实践，我可以在评论我的function时应用？
您可以使用jsdoc风格，以便以后生成文档
像这样
/** * Adds two numbers * @param {Number} a * @param {Number} b * @return {Number} sum */ function sum(a,b) { return a + b; } 编辑：如果您使用AngularJS，那么您可以参考http://google.github.io/styleguide/angularjs-google-style.html
那么，有很多方法可以在javascript中添加注释; 这是我的build议/最佳实践 。
使用//比/* */更好，因为那么你可以使用后者来取出包含其他注释的整个块。 但是，如果您想使用自动文档生成工具，则必须使用类似于javaDoc样式的注释。
这是一个例子，将与YUI DOC（最好的一个） http://developer.yahoo.com/yui/yuidoc/#start
/** * This is a description * @namespace My.Namespace * @method myMethodName * @param {String} str - some string * @param {Object} obj - some object * @param {requestCallback} callback - The callback that handles the response. * @return {bool} some bool */ function SampleFunction (str, obj, callback) { var isTrue = callback(str, obj); // do some process and returns true/false. return isTrue ; }
其他参数例子： – http://usejsdoc.org/tags-param.html
希望这会帮助你:)
我习惯的标准是JSDoc： https ： //github.com/jsdoc3/jsdoc
它的风格类似于javadoc，如果你熟悉的话。
请注意 – 上面的JSDoc风格的答案给你一个很大的优势 – 你可以从它们生成文件。 这是非常有价值的，特别是当你的项目扩大。 如果您对JSDoc不感兴趣，或者您正在寻求有关评论的一般build议，请继续阅读。
如果你已经有一个适合你的文档方法，坚持下去。 如果你喜欢事先解释所有事情的开始部分的大评论块，那就太棒了。 如果你喜欢在特定的行上插入有针对性的评论，请坚持。
另一件要考虑的事情是文化 – 如果这是一个工作项目，请确保代码文档与您的团队产生的内容一致。 同样重要的是，确保你的代码也符合团队标准。
最后的想法 – 保持一致。 一套关于如何logging的规则，即使只是为了你，也会使你的评论更容易阅读，写和理解。 你会知道在哪里找他们，他们会告诉你什么。
