java开发注释规范,开发人员代码注释规范.doc-程序员宅基地

技术标签: java开发注释规范  

开发人员代码注释规范

开发人员代码注释规范

Java类版权及代码注释

注释示例package java.blah;

import java.blah.blahdy.BlahBlah;

/*

* ==========================================================

* Version Author Date Description

* 1.0 huangzhihui 2007-11-05 创建

* ==========================================================

*/

/**

*

Title: Blah.java

*

Description:

*

Copyright: Copyright (c) 2009

*

Company: Eshore Technology Co.,Ltd.

* @author huangzhihui

*

*/

public class Blah extends SomeClass {

/** classVar1 documentation comment */

public static int classVar1;

//classVar2 documentation comment that happens to be

//more than one line long

private static Object classVar2;

/**

* ...constructor Blah documentation comment...

*/

public Blah() {

// ...implementation goes here...

}

/**

* ...method doSomething documentation comment...

*/

public void doSomething() {

// ...implementation goes here...

}

/**

* ...method doSomethingElse documentation comment...

*

detail description

*

*

another description

*

* @param someParam description

* @return return value description

* @throws SomeException exception SomeException description

*

* @see xx.xx.SomeClass#doSomethingElse(String)

*/

public SomeClass doSomethingElse(Object someParam) throws SomeExcetpion{

// ...implementation goes here...

}

}

打开MyEclipse,,Java(Code Style(Code Templates(Code(New Java file,点击右边的“Edit”,将下面的段落覆盖原文后保存。

${package_declaration}

/*

* ==========================================================

* Version Author Date Description

* 1.0 ${user} ${year}-${month}-${date}创建

* ==========================================================

*/

/**

*

Title: ${file_name}

*

Description:

*

Copyright: Copyright (c) ${year}

*

Company: Eshore Technology C

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/weixin_36143628/article/details/115790353

智能推荐

使用docker部署nginx搭建简单的idea-2019 jrebel插件激活服务器_docker 激活服务器 intellij-程序员宅基地

文章浏览阅读759次。之前用的jrebel激活方式一直都是用的 *lanyus* 大神的 [jrebel激活](http://idea.lanyus.com)插件,但是需要一直开着命令行窗口,或者将jrebel调整成离线模式,心血来潮也想自己配置一个反向代理,代理到大神的网站上去_docker 激活服务器 intellij

1024: 计算字母序号_c语言1024计算字母序号-程序员宅基地

文章浏览阅读326次。输入一个英文字母(可能是大写,也可能是小写),输出该字母在字母表中的序号(’a’和’A’的序号为1)。输出一个整数,表示该字母在字母表的序号,输出单独占一行。输入只有一个英文字母。_c语言1024计算字母序号

浅拷贝与深拷贝-程序员宅基地

文章浏览阅读75次。目录 什么是浅拷贝 实现浅拷贝有哪些方法呢? 什么是深拷贝? 实现浅拷贝有哪些方法呢? 总结 什么是浅拷贝如果数据是基本数据类型,在浅拷贝的时候就如同于直接赋值,是拷贝其本身的值;但是如果除了基本数据类型之外还有一..._元素值传入通道(chan)时会被复制,这里是浅表复制还是深层复制?

小偷php杰奇小说源码_杰奇小说系统 v1.8-程序员宅基地

文章浏览阅读604次。杰奇1.8安装使用和更新说明一、1.8程序需要 php 5.3.x + zend guard loader + mysql 5.x二、安装程序还没整理,请手工导入install目录下的 struct.sql 和 data.sql,然后修改 /configs/define.php 设置正确数据库参数后登陆后台管理三、代理原创作品功能代理模式为:由杰奇书盟(book.jieqi.com)获取原创站共享..._杰奇1.8程序

《算法竞赛入门经典》——刘汝佳_刘汝佳.算法竞赛入门经典-程序员宅基地

文章浏览阅读2.7k次。“构造性”和“可行性”是计算机学科的两个最根本特征。比赛的核心是算法#1 语言篇编程不是看会的,也不是听会的,而是练会的,所以应尽量在计算机旁阅读书本,以便把书中的程序输入到计算机中进行调试,顺便再做做上机练习。千万不要图快—如果没有足够的时间来实践,那么学的快,忘得也快!1.1算数表达式原因并不重要,重要的是规范:根据规范做事情,则一切尽在掌握中。提示1-1:整数值用%d输出,实数用%f输出。提示1-2:整数/整数=整数,浮点数/浮点数=浮点数。整数-浮点数=浮点数。一般来说,._刘汝佳.算法竞赛入门经典

转:明茨伯格:组织不需要英雄,只需要有雅量的领导_明茨伯格 斯特德 答案-程序员宅基地

文章浏览阅读2.2k次。冥想,从自满中警醒出来,换个角度来重新考虑一些已经有固定答案的问题_明茨伯格 斯特德 答案

随便推点

linux解锁文件夹-程序员宅基地

文章浏览阅读1.3k次。2、切换到“安全”选项卡,点击“编辑”,选择“添加”,输入au再点检查名称,系统会自动改名为AuthenticatedUsers,点确定。3点击AuthenticatedUsers——完全控制——确定。1、右击这个带锁的文件或者文件夹,选择属性。_linux解锁文件夹

python性能优化方案_6个Python性能优化技巧-程序员宅基地

文章浏览阅读1k次。ython是一门非常酷的语言,因为很少的Python代码可以在短时间内做很多事情,并且,Python很容易就能支持多任务和多重处理。Python的批评者声称Python性能低效、执行缓慢,但实际上并非如此:尝试以下6个小技巧,可以加快Python应用程序。1、关键代码可以依赖于扩展包Python使许多编程任务变得简单,但是对于很关键的任务并不总是提供最好的性能。使用C、C++或者机器语言扩展包来执..._python 性能调优

银河麒麟操作系统内存异常占用bug_麒麟系统aduit bug-程序员宅基地

文章浏览阅读681次。安装银河Kylin系统后,服务器内存,在没有任何服务的情况下,异常升高。_麒麟系统aduit bug

【目标检测】One-stage/Two-stage/Anchor Free_目标检测one-stage,two-stage,anchor-free对比-程序员宅基地

文章浏览阅读2.1k次。文章目录Two-stageOne-stageTwo-Stage和One-Stage方法的结合One-stage和Two-stage的比较Anchor-Freeanchor-free和anchor-based结合——Guided Anchoringhttps://www.zhihu.com/question/266143762/answer/304172590https://blog.csdn...._目标检测one-stage,two-stage,anchor-free对比

vue-router(路由)快速入门 浅析(适合vue小白)_用saber做登录界面-程序员宅基地

文章浏览阅读1.5k次。首先,由于博主学到vue的路由时是基于vue-cli3.0和webpack打包器进行开发的,所以,菜鸟教程和一些官方教程的案例好像并不适合(可能是自己刚学皮毛理解不够深),所以,博主进行了各种查阅,总算写出一个小案例,总结出如下知识点:Vue Router 是 Vue.js 官方的路由管理器。它和 Vue.js 的核心深度集成,让构建单页面应用变得易如反掌。包含的功能有:嵌套的路由/视图表..._用saber做登录界面

hihoCoder#1788 : 偶数长度回文子串_偶数回文子串-程序员宅基地

文章浏览阅读646次。时间限制:5000ms单点时限:1000ms内存限制:256MB描述给定一个小写字母字符串,请判断它是否有长度为偶数的非空连续回文子串输入输入包含多组数据。每组数据包含一行一个小写字母字符串 S1 ≤ |S| ≤ 105输出对于每组数据如果存在,输出YES,否则输出NO样例输入cabbadababa样例输出YESNO 分..._偶数回文子串

推荐文章

热门文章

相关标签