如果你读过Java源码,那你应该已经见到了源码中优美的javadoc.在eclipse 中鼠标指向任何的公有方法都会显示出详细的描述,例如返回值.作用.异常类型等等. 本文主要来自<Thinking in java>的内容以及我在工作中写javadoc的经验. 三种类型的注释文档 注释文档有三种类型,分别对应于注释位置后面的三种元素:类.域和方法.也就说类注释正好位于类定义之前:域注释位于域定义之前:方法注释位于方法定义之前.如图所示: //: object/Documentation1.ja

package com.frank.chapter1; // object.Documentation1.java // TIJ4 Chapter Object, Exercise 13 - 1 /* Run Documentation1.java, Documentation2.java and Documentation3.java * through Javadoc. Verify the resulting documentation with your Web browser. */

JAVA之旅(五)--this,static,关键字,main函数,封装工具类,生成javadoc说明书,静态代码块 周末收获颇多,继续学习 一.this关键字 用于区分局部变量和成员变量同名的情况 this的特点 this就代表本类对象 这在我们的set方法里面是有的 public void setName(String name) { this.name = name; } this代表他所在的函数对属对象的引用 现在我们这里有这么一个需求 //公共的 类 类名 public class H

CMD文档注释编译命令: javadoc -d text Helloword2.java(text 是保存标签文档的文件夹,可以写) javadoc -d doc -encoding UTF-8 -charset UTF-8  -author -version *.java 文档注释编译命令 @see 引用其它文类 @link package.class#member label 和@see 差不多 @docRoot 产生到文档根目录的相对路径 @inheritDoc 从该类的最直接基类中继承文

大量的中文注释,其实最大的目的是想生成中文的Javadoc.但是中文注释实在太不高级了,在各种编码下还会变成乱码.本着高端大气国际化的思路,还是想把它换成英文,但是又不想放弃中文的Javadoc,怎么办呢? stackoverflow上有个帖子,说是在源码里写两种语言的注释,然后用过css切换.还有日本人用freemarker的语法来写Javadoc的http://www.ruimo.com/howto/java/javadoc-i18n/index_en.html.但是看到代码里一堆翻译文本也

一.研发流程规范 二.SQL编码规范 数据库命名规范:数据库名一律小写,必须以字母开头.库名包含多个单词的,以下划线“_”分隔.如果采用分库方案,分库编号从“0”开始,用“0”左补齐为四位. 表名规范:表名一律小写,必须以字母开头.表名中包含多个单词的,以下划线“_”分隔.如果采用分表方案,同时分表编号从“0”开始,用“0”左补齐为四位.建议使用‘数据库名_表名’形式,例如:tkn_users. 字段名和字段类型规范:字段名一律小写,必须以字母开头,言简意赅且不含拼写错误的单词(限用有歧义的缩写

注释是一种形式的元数据,提供了非程序自身的数据,注释对于被注释的代码没有直接的影响. 本文主要概括注释的使用,java平台(SE)预定义的注释,类型注释是如跟可插入类型系统连用达到更强的类型检查的,以及如何实现重复注释. 注释有许多用途,包括: 为编译器提供信息--编译器可以利用注释检查错误或者抑制警告信息 编译时或者部署时处理--软件工具可以处理注释并生成代码,XML文件等等 运行时处理--有些注释在运行时可以被检测到 注释格式 注释最简单的形式如下: @Entity @符号提示编译器接下来的

Updated on 2016/1/6 修正了一些翻译段落欢迎转载,但请保留译者链接:http://www.jianshu.com/p/613d28a3c8a0 Lessons learned from Android developers in Futurice. Avoid reinventing the wheel by following these guidelines. If you are interested in iOS or Windows Phone development

本文来源于我在InfoQ中文站原创的文章,原文地址是:http://www.infoq.com/cn/news/2013/12/common-red-flags-in-java-1 Dustin Marx是一位专业软件开发者,从业已经有17年的时间,他拥有电子工程学士学位,还是一位MBA.Dustin维护着一个博客,专门介绍软件开发的各个主题.近日,他撰文谈到了Java开发中常见的危险信号,提出了在日常的Java开发中我们需要尽力避免的一些不正确的做法.感兴趣的读者可以参见本系列文章的第一部分.

编码规范对于开发人员来说是非常重要的,有以下几个原因: 1.一个软件的生命周期中,80%的花费在于维护 2.几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护 3.编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码 4.如果你将源码作为产品发布,就需要确任它是否被很好的打包并且清晰无误,一如你已构建的其它任何产品 5.为来自不同的项目组或个人提供标准的代码格式. 6.增加易读性. 在不用Java两年多后因工作需要我又要转入Java开发,为此我整理出下面的编码规范,

现代java开发指南 第一部分 第一部分:Java已不是你父亲那一代的样子 第一部分,第二部分 =================== 与历史上任何其他的语言相比,这里要排除c语言和cobol语言,现在越来越多的工作中,有用的代码用Java语言写出.在20年前Java首次发布时,它引了软件界的风暴.在那时,相对c++语言,Java语言要更简单,更安全,而且在一段时间后,Java语言的性能也得到了提升(这依赖于具体的使用情况,一个大型的Java程序于相同的c++程序相比,可能会慢一点,或者一样快,

Javapoet:是生成.java源文件的开源API  github:https://github.com/square/javapoet   以生成一个HelloWrold.java文件为例: package com.example.helloworld; public final class HelloWorld { public static void main(String[] args) { System.out.println("Hello, JavaPoet!"); }

  Google Java Style 中文版     基于官方文档2013.12.19最后一次改动. 翻译人:Weir Zhang (zh.weir) 旁白:水平有限,很多地方只是意译.不准确的地方,大家以原版文档为准. 原版地址:http://google-styleguide.googlecode.com/svn/trunk/javaguide.html       一.介绍   本文档为Google Java编程规范的完整定义.依照此规范编写的Java源码文件可以被称为Google St

转自:http://www.blogjava.net/zh-weir/archive/2014/02/08/409608.html Google Java Style 中文版     基于官方文档2013.12.19最后一次改动. 翻译人:Weir Zhang (zh.weir) 旁白:水平有限,很多地方只是意译.不准确的地方,大家以原版文档为准. 原版地址:http://google-styleguide.googlecode.com/svn/trunk/javaguide.html    

创建对象类型的 1,静态工厂方法代替构造器 静态工厂方法有名称,不容易混乱他的作用 不必再每次调用他的时候创建实例,创建实例的代价是高的,可以重复利用缓存的对象 静态工厂甚至能返回子类对象,例如在接口上(Java8 )的静态方法上,返回一个直接可以用的类 根据参数值,决定不同的返回类型(貌似和上面有点像 返回的类型,可以在写静态工厂时候不存在(貌似用在rpc方面) 缺点 如果不包含公有或包含的构造器,就不能让子类实例化 javadoc不能很好解释 ps vauleOf,转换方法 instance

OO第四单元及学期总结 第四单元两次作业的架构设计 第一次作业 类图: 树形结构:使用Operation类管理UMLOperation以及parent为该UMLOperation的参数(UMLparameter):使用Class.Interface两个类分别管理UMLClass/UMLInterface以及parent为该UMLClass/UMLInterface的属性UMLAttribute.操作(Operation)以及其拥有的类间关系(关联/继承/实现)等:用顶层的myUmlInterac

转自:http://www.blogjava.net/lishunli/archive/2010/01/12/309218.html Technorati 标记: tools 关键词 个性化地生成Javadoc文档,svn eclipse 设置属性 svn:keywords -TortoiseSVN,李顺利, Javadoc 自定义标记,javadoc tag,javadoc version 自动增加,发布到google code Eclipse,javadoc,语言,编码,自定义标记,乱码,版

有时在写代码时,需要查看javadoc文档,便于编写程序.故如何把Javadoc文档整合到MyEclipse,以便于查看呢? 解决办法: 1.在MyEclipse中菜单栏的“Windows”--->“Preferences(首选项)” 2.左侧导航栏找到Java--->Installed JREs,点击Installed JREs,选中你已有的要添加java API.javadoc的jre或jdk. 3.单击右方的“Edit”,出现Edit JRE对话框,如果你是新建,出现New JRE对话框

摘要:我们在写代码时候,往往是想查看一下源码,看看源码的一些细节内容.一般情况下,在IDE(如eclipse)中近仅仅只需按住ctrl+ 点击对应的方法即可进入对应的源码部分.但是有些时候很多依赖项并不会默认下载对应的源码,因此,需要执行以下命令让他自动下载.那么一般需要完成以下三步即可: 1:Maven命令下载源码和javadocs 当在IDE中使用Maven时如果想要看引用的jar包中类的源码和javadoc需要通过maven命令下载这些源码,然后再进行引入,通过mvn命令能够容易的达到这个

原创文章,欢迎阅读,禁止转载.本文记一下javadoc风格注释的写法,这些特殊格式的注释称作标签.按照这种规范写的注释才能生成到文档中. 块注释的写法 /** * @brief 这个块注释 * doxygen标签就是写在这里(除了单行注释) * 格式为双星开始"/** ... */",标签可以写多行 */ 单行注释的写法 int var; ///< 用"///<"的是单行注释 int abc; ///< 常用于全局变量.成员变量.结构体成员.枚举值