草庐IT

JavaScript 注释

coder 2023-07-05 原文

是否有 JavaScript 注释？

当然 JavaScript 没有它们，但是是否有额外的库或建议的语言扩展，例如

@type {folder.otherjsmodule.foo}
function(){
    foo = folder.otherjsmodule.foo();
    ...
    return foo;
};

最佳答案

更新:现在有一个proposal在 JavaScript 中使用适当的装饰器。目前是stage 1你可以在 BabelJS 和 traceur 中使用它。

一些库，比如前面提到的闭包在注释中使用注释，closure compiler甚至在编译时尽可能多地断言类型。然而，这些并不是经典意义上的实际“注释”。

与“显而易见”的答案不同——是的，有 JavaScript 注释，一些运行时支持它们。

例如

(function(){
    "use strict";
    //code in strict mode
})();

这将导致函数内部执行严格模式。最近在 Mozilla 中我们得到了:

(function(){
    "use asm";
    //code in asmjs
})();

这将导致代码以 asmjs 模式运行，优化转译。

我可以在我的库中使用这些注释吗？

是的，虽然面向方面的编程和注解在 JS 中很不常见，但完全有可能编写一个接受函数的库，查看它的 .toString，找出这些注解在哪里结束并执行相关代码，然后是函数的其余部分。

例如

an(function(){
    "validate user"; // this could be something you implement yourself
    "use strict";
})();

创建一个执行此操作的库非常简单，它需要一些讨厌的代码(使用 Function 构造函数并将函数解析为字符串)，但这当然是可能的。它甚至可以在新的开发工具中进行调试，而且几乎与 native 函数一样快。

建议的语法可以是:

an.add("assertEmail",function(x){
    if(!emailRegex.test(x){
        throw new Error("Invalid call to function - expected email got",x);
    }
});

// later on 

an(function subscribeToNewsLetter(x){
    "assertEmail";
    var xhr = new XMLHttpRequest();
    //send email
});

关于JavaScript 注释，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/17065949/

JavaScript注释codesectionfunctionannotations

有关JavaScript 注释的更多相关文章

  1. ruby - 在好的 Ruby 代码中没有注释是否被认为是可以接受的？ - 2

    关闭。这个问题是opinion-based.它目前不接受答案。想要改进这个问题？更新问题，以便editingthispost可以用事实和引用来回答它.关闭5年前。Improvethisquestion我审查了一些用Ruby编写的专业代码，没有发现任何评论。代码读起来相当清晰，但没有self记录。我应该期望专业编写的Ruby代码有注释吗？或者，是否有一些Ruby原则认为注释不是必需的？

  2. 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发生变化)，但它实际上发送了正确的请求类型。这就是这个问题令我困惑的

  3. 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

  4. 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功能。修复:获取文

  5. 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样式。例如

  6. ruby - 使用 YARD 时忽略注释掉的代码 - 2

    我有一些如下所示的Ruby代码:#some_string="{really?}"大括号需要是字符串的一部分。这一行是注释掉的代码，我想保留在那里。我还使用YARD来记录代码，所以当我运行yarddoc时，它(自然地)会发出无法“真正”链接的警告。有没有办法让YARD忽略注释掉的代码？ 最佳答案 IsthereawayIcantellYARDtoignorecommentedoutcode?一方面，YARD记录支持Rdoc标记。并且Rdoc被记录为支持几种隐藏部件的方法。RDocstopsprocessingcommentsifitf

  7. ruby-on-rails - <tt> 在 Ruby 注释中代表什么？ - 2

    查看用Ruby编写的源代码，比如Rails，我经常看到小代码用tt标签包裹，比如rails/activesupport/core_ext/array/access.rb#Equaltoself[2].##%w(abcde).third#=>"c"defthirdself[2]end这背后的约定是什么，何时以及为何决定使用此表示法？ 最佳答案 是的，我错了，抱歉这是特殊RDoc系统的一部分。Non-verbatimtextcanbemarkedup:italic:wordortextbold:wordortexttypewriter:

  8. 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#[]=

  9. ruby - Watir-Webdriver 是否支持点击目标为 javascript 的链接？ - 2

    我是Ruby和Watir-Webdriver的新手。我有一套用VBScript编写的站点自动化程序，我想将其转换为Ruby/Watir，因为我现在必须支持Firefox。我发现我真的很喜欢Ruby，而且我正在研究Watir，但我已经花了一周时间试图让Webdriver显示我的登录屏幕。该站点以带有“我同意”区域的“警告屏幕”开头。用户点击我同意并显示登录屏幕。我需要单击该区域以显示登录屏幕(这是同一页面，实际上是一个表单，只是隐藏了)。我整天都在用VBScript这样做:objExplorer.Document.GetElementsByTagName("area")(0).click

  10. 网页设计期末作业，基于HTML+CSS+JavaScript超酷超炫的汽车类企业网站(6页) - 2

    🎉精彩专栏推荐💭文末获取联系✍️作者简介:一个热爱把逻辑思维转变为代码的技术博主💂作者主页:【主页——🚀获取更多优质源码】🎓web前端期末大作业：【📚毕设项目精品实战案例(1000套)】🧡程序员有趣的告白方式：【💌HTML七夕情人节表白网页制作(110套)】🌎超炫酷的Echarts大屏可视化源码：【🔰Echarts大屏展示大数据平台可视化(150套)】🔖HTML+CSS+JS实例代码：【🗂️5000套HTML+CSS+JS实例代码(炫酷代码)继续更新中…】🎁免费且实用的WEB前端学习指南：【📂web前端零基础到高级学习视频教程120G干货分享】🥇关于作者:💬历任研发工程师，技术组长，教学总监；

随机推荐