java.注释类型

原文同步至:http://www.waylau.com/java-comments-conventions/ 在 Java 的编写过程中我们需要对一些程序进行注释,除了自己方便阅读,更为别人更好理解自己的程序,所以我们需要进行一些注释,可以是编程思路或者是程序的作用,总而言之就是方便自己他人更好的阅读. 注释类型 Java 有两类注释: implementation comments(实现注释)和 documentation comments(文档注释). 实现注释常见于 C++,使用 /*..

一.java注释 1.单行注释  //注释内容 2.多行注释 /*注释内容*/ 3.文档注释(可用javadoc工具生成api文档,不过我还没试过)/**文档注释*/,文档注释可以在使用的时候看见注释. 文档注释常用的标记 @auther作者 @version版本 @deprecated 不推荐使用 @param 本放的参数 @return 返回值 @throws异常,同@exception 二.java的命名 1.项目名 字母全部小写 2.包名 全部小写 3.类名 首字母大写加驼峰 4.方法名

1.Java注释: 1 import cn.lonecloud.Doc; 2 3 /** 4 * Created by lonecloud on 2017/8/17. 5 * 测试注释类型 {@link Doc#test() 测试这个标签作用} 6 * @author lonecloud 7 * @see cn.lonecloud.Doc 8 * @version 1.0 9 * 10 */ 11 @Deprecated 12 public class JavaDocDemo { 13 /**

深入理解Java:注解(Annotation)自定义注解入门 ---- http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html 深入理解Java:注解(Annotation)--注解处理器 -----http://www.cnblogs.com/peida/archive/2013/04/26/3038503.html 其中第一个文章里面提到的: 有四个元注解: 为JDK的解释: Documented : 指示某一类型的注释将通过

Java注释总结 注释风格设置方法: WindowàpreferencesàJavaàCode StyleàCode TemplatesàComments javadoc注释 @author      类作者 @version     类版本 @see       转向参考 @param      方法参数说明 @return      方法返回值说明 @exception    方法异常说明     描述内容可以使用html标签 类中: 方法中: 注释快捷键 对类做注释在类的上一行打出"/**

 Java注释Annotation 从JDK 5开始,Java增加了对元数据(MetaData)的支持,也就是Annotation(注释).Annotation提供了一种为程序元素设置元数据的方法,程序元素包括修饰包.类.构造器.方法.成员变量.参数.局部变量,从某些方面来看,Annotation就想修饰符一样,可用于程序元素的声明,这些信息被存储在Annotation的"name = value"对中. 需要注意的是, Annotation是一个接口,程序可以通过反射来获取指定程

myeclipse自定义java注释: Window->Preference->Java->Code Style->Code Template 然后展开Comments节点就是所有需设置注释的元素 ----------------- 文件 (Files) 注释标签: /** * @Project : ${project_name} * @Title : ${file_name} * @Package ${package_name} * @Description : ${todo}

在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个<Java的注释规范>,内容来自网络.书籍和自己的实际积累. JAVA注释规范 版本/状态 作者 版本日期 1.0 ghc 2008-07-02 一.背景 1.当我们第一次接触某段代码,但又被要求在极短的时间内有效地分析这段代码,我们需要什么样的注释信息? 2.怎么样避免我们的注释冗长而且凌乱不堪呢? 

Java 注释 标签 : Java基础 五月份得知入职阿里云OS, 才开始学Java, 断断续续学习/使用半年, 越来越喜欢这个语言/工具. 后来被拥抱变化之后, 拿到的大部分offer是Java服务端研发; 一路走来, 踩了很多坑, 也有了一点小小的心得, 而且博客已经停更几个月, 今天就以博客形式把他记录下来吧. 2015下半年第一篇博客, 从最基础的Java注释开始: 程序员圈有一个笑话 最讨厌在写代码的时候写注释, 最讨厌别人的代码里面不写注释. 为什么写注释? 我自己亲身经历: 这段时