java过时的代码注释 简单的java程序代码带注释

java 怎样给源代码添加注释

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

相关问答

Q1: 大神谁帮我注释下这段java代码啦~最好详细点~

import java.applet.*; //java过时的代码注释你在写Applet，所以你导入了Java中有关Appletjava过时的代码注释的类

import java.awt.Graphics; //引入了awt的另一个类：Graphics

public class MovingCharacter extends Applet implements Runnable { //类：MovingCharacter：继承了Applet类，实现了Runnable接口

int x=200; //横坐标

Thread my_thread=null; //声明了一个线程变量 可以改为Thread my_thread;

public void start() //启动过程

{ my_thread=new Thread(this); //修改了my_thread线程对象

my_thread.start(); //启动TA

}

@Override //说明覆盖

public void run() { //那个线程运行什么，这是实现了Runnable的接口的run()方法

// TODO Auto-generated method stub //Eclipse的自动生成的方法，留下了痕迹

repaint(); //重新绘制（不太懂Applet）

try { Thread.sleep(100); //睡100毫秒

} catch(InterruptedException e){} //异常处理，空的

}

public void stop() //停止线程的方法

{ my_thread.stop(); //让线程停下来}

public void paint(Graphics g) //绘图方法，接受一个Graphics的对象

{ g.drawString("Hello, Java!",x,30); //添加字符Hello，Java！

x-=10; //横坐标变量-10

if(x0) x=200; //如果横坐标0重设为200

}

}

Q2: Java代码注释

ResourceBundle res;

//打开对应的db.prop属性文件文件，和你的java class同一目录下

res = ResourceBundle.getBundle("db");

//从文件中取得ulr, user, password, jdbc driver名字

String url=res.getString("url");

String user=res.getString("user");

String password=res.getString("password");

String className = res.getString("classname");

try{

//初始化你的jdbc dirver

Class.forName(className).newInstance();

//建立connection

conn = DriverManager.getConnection(url,user,password);

}catch(Exception e)

{

e.printStackTrace();

}

return conn;

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

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

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

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

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

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

Rule #1: do Javadoc how not to

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

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

Rule #2: do not Javadoc how to

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

Rule #3: 不要在JavaDoc中解释

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

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

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

Rule #4: do deprecate

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

java过时的代码注释的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于简单的java程序代码带注释、java过时的代码注释的信息别忘了在本站进行查找喔。