草庐IT

JavaDoc 接口(interface)评论

coder 2024-03-08 原文

<分区>

我有一个接口(interface) A，它有方法 x、y 和 z。我是这样评论类(class)的:

/**
 * 
 * A.java
 * Interface class that has the following methods.
 * 
 * @author MyName
 * @since mm-dd-yyyy
 */

public interface A {

    //method description for x
    void x();

    //method description for y
    void y();

    //method description for z
    void z();
}

是否应该在类评论中添加其他内容？

interfaceJavaDocsectionclassnoticejavacomments

有关JavaDoc 接口(interface)评论的更多相关文章

  1. ruby-on-rails - 简单的 Ruby on Rails 问题——如何将评论附加到用户和文章？ - 2

    我意识到这可能是一个非常基本的问题，但我现在已经花了几天时间回过头来解决这个问题，但出于某种原因，Google就是没有帮助我。(我认为部分问题在于我是一个初学者，我不知道该问什么......)我也看过O'Reilly的RubyCookbook和RailsAPI，但我仍然停留在这个问题上.我找到了一些关于多态关系的信息，但它似乎不是我需要的(尽管如果我错了请告诉我)。我正在尝试调整MichaelHartl'stutorial创建一个包含用户、文章和评论的博客应用程序(不使用脚手架)。我希望评论既属于用户又属于文章。我的主要问题是:我不知道如何将当前文章的ID放入评论Controller。

  2. postman接口测试工具-基础使用教程 - 2

    1.postman介绍Postman一款非常流行的API调试工具。其实，开发人员用的更多。因为测试人员做接口测试会有更多选择，例如Jmeter、soapUI等。不过，对于开发过程中去调试接口，Postman确实足够的简单方便，而且功能强大。2.下载安装官网地址:https://www.postman.com/下载完成后双击安装吧，安装过程极其简单，无需任何操作3.使用教程这里以百度为例,工具使用简单，填写URL地址即可发送请求，在下方查看响应结果和响应状态码常用方法都有支持请求方法:getpostputdeleteGet、Post、Put与Delete的作用get：请求方法一般是用于数据查询，

  3. ruby - .gemrc 评论？ - 2

    这是一个基本问题.gemrc文件中是否允许注释？如果是，你会怎么做？我这里查了没用docs.rubygems.org/read/chapter/11 最佳答案 文档说:Theconfigfileitselfisin’’’YAML’’’format.这意味着您可以拥有commentsstartingwith#，例如:#Ilikedocsrdoc:--inline-source--line-numbers 关于ruby-.gemrc评论？，我们在StackOverflow上找到一个类似的问题

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

  5. ruby - 评论限制 - 2

    在ruby​​1.9中，放宽了行结束位置的条件，因此我们现在可以用句号开始一行来显示方法调用。当我们混淆了链式和非链式方法，并希望显示下一个非链式方法的开始位置时，这很方便。如果没有这个新功能，我们能做的最好的可能就是使用缩进:method1(args1).method2(args2).method3(args3)method4(args4).method5(args5).method6(args6)或插入一个空行。但这很不方便，因为我们必须注意缩进，同时，不要忘记在每个方法调用之后加上链中最后一个方法调用之后的句点。正因为如此，我制造了很多错误，要么有一个额外的周期，要么有一个缺失的

  6. ruby-on-rails - 如何在 Rails 中正确呈现嵌套评论？ - 2

    我试图让嵌套评论在Rails5应用程序中正常工作，但遇到了很多困难。我正在构建一个问答网站，我有一个Acomment模型，其中有属于答案的评论，还有属于其他评论的评论:classAcomment我想显示所有评论，然后显示所有对评论的回复，以及对回复的回复等。但是我不知道如何使嵌套正常工作。在我看来，在每个循环中，我正在渲染_comment.html.erb部分:"comment",:object=>comment%>然后，在我的_comment.html.erb局部中，我显示评论、回复链接，然后呈现评论回复的局部:comment,:answer_id=>comment.answer)i

  7. ruby-on-rails - 如何在 RubyOnRails 中使用 'acts as nested set' 创建一个可排序的接口(interface) - 2

    我一直在为使用acts_as_list的模型实现一些不错的交互界面，这些界面可以对我的mRails应用程序中的列表进行排序。我有一个排序函数，在每次拖放之后使用sortable_elementscript.aculo.us函数调用并设置每条记录的位置。这是在拖放完成后处理排序的Controller操作示例:defsortparams[:documents].each_with_indexdo|id,index|Document.update_all(['position=?',index+1],['id=?',id])endend现在我正在尝试对嵌套集模型(acts_as_nested

  8. Ruby:评论是代币吗？ - 2

    我刚刚在这里(http://ruby.runpaint.org/programs#lexical)读到评论是标记。我从未将评论视为标记，因为它们要么是注释，要么是用于后处理器。评论真的是标记还是这个来源有误？ 最佳答案 是的，它们应该是标记，但稍后会被解析器忽略。如果您使用如下所示的文件执行ruby--dumpparsetreefoo.rb#thisisacomment1+1#anothercomment这是你会得到的:#@NODE_SCOPE(line:3)#+-nd_tbl:(empty)#+-nd_args:#|(nullno

  9. ruby - 使用 YARD for Ruby 文档的内部评论？ - 2

    我正在将我维护的ruby​​gem从RDoc切换到YARD文档。但是，代码中有一些关键注释只需要保留在代码中，不应出现在文档中。例如:###SomeClassdocumentationhere.#--#CRITICALcommentthatshouldbeinthecodebutnotinthedocumentation,#andmustbeatthisparticularspotinthecode.#++#moredocumentationthatfollowsthecriticalcommentblock,butthispart#shouldbeinthegenerateddocu

  10. 你真正了解什么是接口测试么？接口实战一“篇”入魂 - 2

    最近在工作中，看到一些新手测试同学，对接口测试存在很多疑问，甚至包括一些从事软件测试3，5年的同学，在聊到接口时，也是一知半解；今天借着这个机会，对接口测试做个实战教学，顺便总结一下经验，分享给大家。计划拆分成4个模块跟大家做一个分享，（接口测试、接口基础知识、接口自动化、接口进阶）感兴趣的小伙伴记得关注，希望对你的日常工作和求职面试，带来一些帮助。注：文章较长有5000多字，希望小伙伴们认真看完，当然有些内容对小白同学不是太友好，如果你需要详细了解其中的一些概念或者名词，请在文章之后留言，后续我将针对大家的疑问，整理输出一些大家感兴趣的文章。随着开发模式的迭代更新，前后端分离已不是新的概念，

随机推荐