一.注释格式分类: 1.单行(single-line)注释://…… 2.块(block)注释:/*……*/ 3.文档注释:/**……*/ javadoc有如下: 二.加注释的场景: 1. 基本注释(必须加) (a)类(接口)的注释 (b)构造函数的注释 (c)方法的注释 (d)全局变量的注释 (e)字段/属性的注释 2. 特殊必须加注释(必须加) (a)典型算法 必须有注释. (b)在代码不明晰处必须有注释. (c)在代码修改处加上修改标识的注释. (d)在循环和逻辑分支组成的代码中加注释.…

java代码注释规范   代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率.也是程序代码可维护性的重要环节之一.所以我们不是为写注释而写注释.下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下. 原则: 1.注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2.注释内容准确简洁 内容要简单.明了.含义准确,防止注释…

代码注释是架起程序设计者与程序阅读者之间的通信桥梁,最大限度的提高团队开发合作效率.也是程序代码可维护性的重要环节之一.所以我们不是为写注释而写注释.下面说一下我们在诉求网二期开发中使用的代码注释规范,供大家参考下. 原则: 1.注释形式统一 在整个应用程序中,使用具有一致的标点和结构的样式来构造注释.如果在其它项目中发现它们的注释规范与这份文档不同,按照这份规范写代码,不要试图在既成的规范系统中引入新的规范. 2.注释内容准确简洁 内容要简单.明了.含义准确,防止注释的多义性,错误的注释不但无…

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

注释是写给读者看的,并不会被执行! 单行注释 以 //开头 例如://注释内容              可以注释一行文本 多行注释 以/*开头     以 */结束 例如:/*注释内容*/            可以注释一段文本 文档注释 JavaDOS 以  /** 开头        */ 结束…

Version:0.9 StartHTML:-1 EndHTML:-1 StartFragment:00000099 EndFragment:00018736 在软件开发的过程中总是强调注释的规范,但是没有一个具体的标准进行说明,通常都是在代码编写规范中简单的描述几句,不能作为一个代码注释检查的标准和依据,做什么都要有一个依据吗:),现在我特整理了一个<Java的注释规范>,内容来自网络.书籍和自己的实际积累.JAVA注释规范 版本/状态 作者 版本日期 1.0 ghc 2008-07-02…

一.命名规范 1. 项目名全部小写 2. 包名统一使用小写,点分隔符之间有且仅有一个自然语义的英语单词,包名统一使用单数形式.如果类名有复数含义,类名可以使用复数形式. 实际应用中: 各层命名规约: A) Service / DAO 层方法命名规约 1 ) 获取单个对象的方法用 get 做前缀. 2 ) 获取多个对象的方法用 list 做前缀. 3 ) 获取统计值的方法用 count 做前缀. 4 ) 插入的方法用 save( 推荐 ) 或 insert 做前缀. 5 ) 删除的方法用 remo…

Java语言基础组成:关键字.标识符.注释.常量和变量.运算符.语句.函数.数组 一．标识符 标识符是在程序中自定义的一些名称,由大小写字母[a-zA-Z],数字[0-9],下划线[ _ ],特殊字符[$]组成. 1. 标识符的命名规则 (1) 数字不可以开头 (2) 不可以使用关键字 (3) Java中严格区分大小写 合法的标示符:以字母.$._开头,列如:name $name _name 非法的标示符: 以数字和特殊字符开头或含有特殊字符 如1name #name %name  n%ame …

第1天 Java基础语法 今日内容介绍 u Java开发环境搭建 u HelloWorld案例 u 注释.关键字.标识符 u 数据(数据类型.常量) 第1章 Java开发环境搭建 1.1 Java概述 众所周知Java是一门编程语言,编程语言就是用来编写软件的.那么使用Java到底能用来编写什么软件呢?你所熟知的很多软件都可以用Java来编写,例如:QQ.迅雷.淘宝.京东等等,那么Java比较擅长什么呢?也就是说我们将来从事Java开发工程师工作到底要编写什么类型的软件呢? 答案是: 互联网:电…

前言:      现在java的出产地sun公司并没有定义一个java注释规范,注释规范目前是每个公司自己有自己的一套规范,主要是为了团队之间的协作. 1.基本规则      1.注释应该使代码更加清晰易懂      2.注释要简洁明了,只要提供能够明确理解程序必要的信息就可以了.如果注释太复杂会影响程序整洁度和阅读感.      3.注释不仅描述程序作了什么,还要描述为什么这样做以及约束.      4.对于一般的getter和setter方法不用注释.      5.类.接口.构造函数.方法…