javascript - Netbeans javascript 评论

coder 2024-05-08 原文

我最近发现 Netbeans 非常喜欢这样格式的 javascript 注释:

/**
 * This is a sample comment
 * 
 * @param {Number} myParam info about this parameter
 * @return {String} Returns some sample string.
 */
function sample(info) { .. }

这似乎是 Javadoc 兼容的注释，但它是吗？某处是否有资源定义可接受的格式？另外，这种注释风格是否常见于其他 IDE，例如 Eclipse？

编辑:我上传了这张截图来说明 Netbeans 如何解释@param 和@return

谢谢。

最佳答案

注释标签类似于JSDoc3，但并非所有的JSDoc3 标签都支持。 JSdocs 3 中缺少一些标签(它们在下面的列表中没有引用)。

您可以通过这种方式查看哪些可用:

使用/** 开始评论并按 Enter；
在评论中输入@;
使用 Ctrl + Space (Netbeans) 在 @ 符号后调用代码补全。

它将向您显示支持的标签列表并帮助您了解其语法(参数自动完成)。随着用户发布多个错误报告，预计 future 的 Netbeans 版本将支持更多标签。

以下是 Netbeans 7.4 支持的标签列表:

@argument //定义参数类型、名称和描述。
@augments //此对象添加到父对象上。
@author //标识项目的作者。
@borrows //这个对象使用了另一个对象的东西。
@class //使用下面的文字来描述整个类。
@constant //将对象记录为常量。
@constructor //此函数旨在使用“new”关键字调用。
@constructs //这个函数成员将成为前一个类的构造函数。
@default //记录默认值。
@deprecated //记录这不再是首选方式。
@description //描述一个符号。
@extends //类型对象继承自.
@field //一个字段。
@fileoverview //描述一个文件。
@function //一个函数。
@ignore //[todo] 从最终输出中删除它。
@inner //记录一个内部对象。
@lends //记录对象字面量的属性，就好像它们属于具有给定名称的符号。
@link //内联标签 - 创建一个链接。
@memberof //这个符号属于一个父符号。
@name //记录一个对象的名称。
@namespace //记录命名空间对象。
@param //记录函数的参数。
@private //这个符号是私有(private)的。
@property //记录对象的属性。
@public //这个符号是公开的。
@requires //这个文件需要一个 JavaScript 模块。
@return //返回。
@returns //记录函数的返回值。
@see //请参阅其他一些文档以获取更多信息。
@since //这个功能是什么时候添加的？
@static //记录一个静态成员。
@syntax //解释语法。
@throws //描述可能抛出的错误。
@type //记录对象的类型。
@version //记录项目的版本号。

关于javascript - Netbeans javascript 评论，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/6333215/

有关javascript - Netbeans javascript 评论的更多相关文章

ruby-on-rails - 简单的 Ruby on Rails 问题——如何将评论附加到用户和文章？ - 2
我意识到这可能是一个非常基本的问题，但我现在已经花了几天时间回过头来解决这个问题，但出于某种原因，Google就是没有帮助我。(我认为部分问题在于我是一个初学者，我不知道该问什么......)我也看过O'Reilly的RubyCookbook和RailsAPI，但我仍然停留在这个问题上.我找到了一些关于多态关系的信息，但它似乎不是我需要的(尽管如果我错了请告诉我)。我正在尝试调整MichaelHartl'stutorial创建一个包含用户、文章和评论的博客应用程序(不使用脚手架)。我希望评论既属于用户又属于文章。我的主要问题是:我不知道如何将当前文章的ID放入评论Controller。
ruby-on-rails - 使用 javascript 更改数据方法不会更改 ajax 调用用户的什么方法？ - 2
我遇到了一个非常奇怪的问题，我很难解决。在我看来，我有一个与data-remote="true"和data-method="delete"的链接。当我单击该链接时，我可以看到对我的Rails服务器的DELETE请求。返回的JS代码会更改此链接的属性，其中包括href和data-method。再次单击此链接后，我的服务器收到了对新href的请求，但使用的是旧的data-method，即使我已将其从DELETE到POST(它仍然发送一个DELETE请求)。但是，如果我刷新页面，HTML与"new"HTML相同(随返回的JS发生变化)，但它实际上发送了正确的请求类型。这就是这个问题令我困惑的
ruby - .gemrc 评论？ - 2
这是一个基本问题.gemrc文件中是否允许注释？如果是，你会怎么做？我这里查了没用docs.rubygems.org/read/chapter/11 最佳答案文档说:Theconfigfileitselfisin’’’YAML’’’format.这意味着您可以拥有commentsstartingwith#，例如:#Ilikedocsrdoc:--inline-source--line-numbers 关于ruby-.gemrc评论？，我们在StackOverflow上找到一个类似的问题
ruby - 在 Mechanize 中使用 JavaScript 单击链接 - 2
我有这个:AccountSummary我想单击该链接，但在使用link_to时出现错误。我试过:bot.click(page.link_with(:href=>/menu_home/))bot.click(page.link_with(:class=>'top_level_active'))bot.click(page.link_with(:href=>/AccountSummary/))我得到的错误是:NoMethodError:nil:NilClass的未定义方法“[]” 最佳答案那是一个javascript链接。Mechan
ruby - 用一个＃!在 Ubuntu 中运行的 ruby 中评论 - 2
我是编程新手，正在尝试遵循使用#!用ruby评论。我一直收到消息:bash:matz.rb:找不到命令我正在使用这个评论:#!/usr/bin/envruby我试过有和没有后面的空格!以及有和没有环境。当我使用$哪个rubyruby在:/usr/bin/ruby我还进入了操作系统，将所有用户对文件matz.rb的权限更改为rwx，但没有任何效果。是我做错了什么还是我的系统设置不正确？最佳答案 /usr/bin/env部分没问题。运行时需要为bash提供matz.rb的路径。如果您在matz.rb所在的目录中，请键入“./matz.
javascript - jQuery 的 jquery-1.10.2.min.map 正在触发 404(未找到) - 2
我看到有关未找到文件min.map的错误消息:GETjQuery'sjquery-1.10.2.min.mapistriggeringa404(NotFound)截图这是从哪里来的？最佳答案如果ChromeDevTools报告.map文件的404(可能是jquery-1.10.2.min.map、jquery.min.map或jquery-2.0.3.min.map，但任何事情都可能发生)首先要知道的是，这仅在使用DevTools时才会请求。您的用户不会遇到此404。现在您可以修复此问题或禁用sourcemap功能。修复:获取文
ruby - 评论限制 - 2
在ruby1.9中，放宽了行结束位置的条件，因此我们现在可以用句号开始一行来显示方法调用。当我们混淆了链式和非链式方法，并希望显示下一个非链式方法的开始位置时，这很方便。如果没有这个新功能，我们能做的最好的可能就是使用缩进:method1(args1).method2(args2).method3(args3)method4(args4).method5(args5).method6(args6)或插入一个空行。但这很不方便，因为我们必须注意缩进，同时，不要忘记在每个方法调用之后加上链中最后一个方法调用之后的句点。正因为如此，我制造了很多错误，要么有一个额外的周期，要么有一个缺失的
ruby-on-rails - 我将 Rails3 与 tinymce 一起使用。如何呈现用户关闭浏览器javascript然后输入xss？ - 2
我有一个用Rails3编写的站点。我的帖子模型有一个名为“内容”的文本列。在帖子面板中，html表单使用tinymce将“content”列设置为textarea字段。在首页，因为使用了tinymce，post.html.erb的代码需要用这样的原始方法来实现。.好的，现在如果我关闭浏览器javascript，这个文本区域可以在没有tinymce的情况下输入，也许用户会输入任何xss，比如alert('xss');.我的前台会显示那个警告框。我尝试sanitize(@post.content)在posts_controller中，但sanitize方法将相互过滤tinymce样式。例如
ruby - 使用 Selenium WebDriver 启用/禁用 javascript - 2
出于某种原因，我必须为Firefox禁用javascript(手动，我们按照提到的步骤执行http://support.mozilla.org/en-US/kb/javascript-settings-for-interactive-web-pages#w_enabling-and-disabling-javascript)。使用Ruby的SeleniumWebDriver如何实现这一点？最佳答案是的，这是可能的。而是另一种方式。您首先需要查看链接Selenium::WebDriver::Firefox::Profile#[]=
ruby-on-rails - 如何在 Rails 中正确呈现嵌套评论？ - 2
我试图让嵌套评论在Rails5应用程序中正常工作，但遇到了很多困难。我正在构建一个问答网站，我有一个Acomment模型，其中有属于答案的评论，还有属于其他评论的评论:classAcomment我想显示所有评论，然后显示所有对评论的回复，以及对回复的回复等。但是我不知道如何使嵌套正常工作。在我看来，在每个循环中，我正在渲染_comment.html.erb部分:"comment",:object=>comment%>然后，在我的_comment.html.erb局部中，我显示评论、回复链接，然后呈现评论回复的局部:comment,:answer_id=>comment.answer)i

javascript - Netbeans javascript 评论

有关javascript - Netbeans javascript 评论的更多相关文章

随机推荐