java废弃代码注释,java废弃注解

java 怎样给源代码添加注释

1、单行(single-line)--短注释：//…… 单独行注释：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。 注释格式：/* 注释内容 */ 行头注释：在代码行的开头进行注释。主要为了使该行代码失去意义。 注释格式：// 注释内容 行尾注释：尾端(trailing)--极短的注释，在代码行的行尾进行注释。一般与代码行后空8（至少4）个格，所有注释必须对齐。 注释格式：代码 + 8（至少4）个空格 + // 注释内容 2、块(block)--块注释：/*……*/ 注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成： /* * 注释内容 */ 3、文档注释：/**……*/ 注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符 /**......*/ ...

相关问答

Q1: java里已经注释掉的代码该不该删掉？

你好，很高兴回答你的问题。

注释掉的代码，是不会再参与到执行中的。

删除不删除完全看你认为这段代码有没有留着的必要，比如可能会恢复或者是可能有一定的参考价值。

如果有帮助到你，请点击采纳。

Q2: java中怎么把一整段注释掉？怎么去掉注释符？

选中代码 ctrl+/ 是每一行代码前面加注释 //

ctrl+shift+/ 是/* */注释

取消是同样的操作，已有注释的就会取消没有就会加注释（前提是你已经设置了快捷键，我说的这些是默认的快捷键eclipse中的）

Q3: 如何正确地使用Java的@deprecated 标注

Rule #1: do Javadoc how not to

每当你弃用某方法时，创建JavaDoc告诉其他程序员如何不再使用这个方法。不要只说“这个方法废弃了，不要用它”。因为这就是废弃标注和JavaDoc中@deprecated的字面意义，完全没有必要再重复一遍。Java开发人员作为目标受众，都知道deprecation的意思。

命名新的方法，取代旧有的。(使用@link标注!)这可能还不够，新的方法对应的文档将解释如何使用它。不要在JavaDoc中重复（其字面意义），文档也应遵从DRY原则。另一方面你可能想要描述怎样替换掉旧方法的调用，你可以就重构的细节给出提示。

Rule #2: do not Javadoc how to

移除过时的JavaDoc文档。有些人可能争辩：维护遗留代码的用户可能还会需要这些文档。事实上，他们使用的是旧版本库中的旧版本方法。旧版本的文档仍旧存在那里，像被刻在石头上（更确切的说是刻在资源仓库的某个版本上）。含有被废弃掉的方法的实际版本不应包含过时的描述文档，那会鼓励程序员去继续使用。对于废弃的方法，只有一种用法：不去用。JavaDoc应该被实时描述，如同rule#1所述。

Rule #3: 不要在JavaDoc中解释

不要在JavaDoc中解释为什么方法被废弃了。你是一个可靠的的开发，这是你的决定，你的选择，其他人只能忍着。如果愿意，可以写一篇博客记录这次调整的决策背景。这可能有帮助，但它不应被写在JavaDoc中。

JavaDoc的Deprecated API专用来讲解如何不再使用。

重点是如何(how)。而不是“为什么不再使用它(why)”。

Rule #4: do deprecate

如果你觉得需要弃用一方法，那就去做吧！如果你害怕你的用户，或不想因你废弃掉一些方法导致你用户体验更加痛苦，这个决定将让你自己痛苦。尽你所能去让API维持长久的稳定。但如果有需要被废弃的：立刻扔掉它。不要因“为何当初设计API时没有考虑到未来的变动”而感到愧疚。没有人能完美的预见未来。毕竟，如果你知道未来，生活就无趣了。

Q4: java 源代码注释

import java.awt.*;

import java.awt.event.ActionEvent;

import java.awt.event.ActionListener;

import javax.swing.*;

public class GameTest extends JFrame implements ActionListener{

/*

* 新建一个主面板(这个类可能是自定义的，本程序和API中没有)。

*/

MainPanel j=new MainPanel();

JButton jPreview;

JLabel label;

Container container;

JPanel panel;

/**

* 主函数

* @param args

*/

public static void main(String[] args) {

//运行程序

new GameTest();

}

/**

* 构造函数。

*

*/

public GameTest()

{

//新建一个标题为“拼图”的窗口

JFrame fr =new JFrame("拼图");

//获取窗口容器。

container=fr.getContentPane();

//创建菜单条

JMenuBar jMenuBar=new JMenuBar();

//以下初始化菜单，并且设置快捷键和添加监听器。

JMenu jMenuGame=new JMenu("游戏(G)");

jMenuGame.setMnemonic('g');

JMenuItem jMenuItemStart = new JMenuItem("开始(S)");

jMenuItemStart.setMnemonic('s');

jMenuItemStart.addActionListener(this);

JMenuItem jMenuItemExit=new JMenuItem("退出(E)");

jMenuItemExit.setMnemonic('e');

jMenuItemExit.addActionListener(this);

jMenuGame.add(jMenuItemStart);

jMenuGame.add(jMenuItemExit);

//初始化按钮并设置快捷键和添加监听器

JButton jChoice=new JButton("选图(X)");

jChoice.setMnemonic('x');

jChoice.addActionListener(this);

jPreview=new JButton("预览(P)");

jPreview.setMnemonic('p');

jPreview.addActionListener(this);

//将菜单和按钮添加到菜单条中

jMenuBar.add(jMenuGame);

jMenuBar.add(jChoice);

jMenuBar.add(jPreview);

//将菜单条设为该窗口的主菜单

fr.setJMenuBar(jMenuBar);

//将主面板添加到该窗口的容器中。

container.add(j);

//设置大小

fr.setSize(315,360 );

fr.setVisible(true);

//设置默认关闭方式。

fr.setDefaultCloseOperation(3);

}

/**

* 事件处理函数。

*/

public void actionPerformed(ActionEvent e) {

if(e.getActionCommand()=="开始(S)")

{

j.Start();

}

if(e.getActionCommand()=="预览(P)")

{

j.setVisible(false);

panel=new JPanel();

Icon icon=new ImageIcon("pictrue/pic"+"_"+MainPanel.pictureID+".jpg");

label=new JLabel(icon);

label.setBounds(300, 300, 0, 0);

panel.add(label);

panel.setSize(300, 300);

panel.setVisible(true);

this.container.add(panel);

jPreview.setText("返回(P)");

}

if(e.getActionCommand()=="返回(P)")

{

panel.setVisible(false);

j.setVisible(true);

j.repaint();

jPreview.setText("预览(P)");

}

if(e.getActionCommand()=="退出(E)")

{

System.exit(0);

}

if(e.getActionCommand()=="选图(X)")

{

//初始化选择框，并提供选择。

Choice pic = new Choice();

pic.add("七里香");

pic.add("依然范特西");

pic.add("八度空间");

pic.add("十一月的肖邦");

pic.add("魔杰座");

pic.add("叶惠美");

pic.add("我很忙");

int i=JOptionPane.showConfirmDialog(this, pic, "选择图片", JOptionPane.OK_CANCEL_OPTION);

if(i==JOptionPane.YES_OPTION)

{

//选择图片

MainPanel.pictureID=pic.getSelectedIndex()+1;

j.removeAll();

j.reLoadPicture();

j.repaint();

}

}

}

}

Q5: java中 把一整段注释掉 有什么方法？？ 相反的 把注释掉的代码前的注释符去掉 有什么方法？？

需要一个标识符，标识多行注释是否开始

读取一行:

（1）判断此行内是否包含“/＊“,如果包含，定位到“/＊“第一个字符，并标识多行注释开始，继续判断当前读取行是否包含"*/"，如果包含,注释部分删除，其他写回文件，未包含删除，及以后的只判断多行结束，直至判断到多行注释结束，把注释部分删除

（2）多行注释未开始，则判断此行内是否包含“//“,如果包含，定位到“//“第一个字符，把后面的全部删除，注意多行注释开始的当前行，还要再判断一次“//“，因为java支持以下注释

//单行注释/*

*多行注释

*/

其实在代码当中适当加点注释，对自己、别人阅读代码以及以后维护都是有好处的，没必要删除全部的注释，而且编译会跳过注释部分，就算你把一部武侠小说加到代码注释里，也不会影响编译出来的文件大小的