gpt4 book ai didi

java - 我应该使用 "non-Javadoc"评论吗?

转载 作者:IT老高 更新时间:2023-10-28 20:53:05 26 4
gpt4 key购买 nike

我实现了在接口(interface)中定义的自己的方法。但是,当我尝试将 Javadoc 添加到此方法时,Eclipse 给了我这样的评论:

/* (non-Javadoc)
* @see javax.servlet.ServletContextListener#contextInitialized(javax.servlet.ServletContextEvent)
*/

其实我真的需要给这个方法加点注释。我该怎么办?

最佳答案

在这里添加非 javadoc 注释的想法是,在生成的 javadoc 中,继承方法的注释将被复制,这可能就足够了 - 并且比你有一个空的 /** */ 评论。同时,您可以使用源代码中的链接查找方法。正如 Ken 所说,您可以随时更改它。

如果您想包含接口(interface)的文档,请在评论中使用 {@inheritDoc}

关于java - 我应该使用 "non-Javadoc"评论吗?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/6338266/

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com