Java基础学习总结（36）—

代码注释是对代码设计者、代码阅读者以及系统间调用提供了有效的帮助，最大限度的提高团队开发合作效率增强系统的可维护性。我们追求简化，不是为了写注释而写注释。

（快速使用请直接看六、七、八）

一、原则：

1.注释形式统一

使用统一的注释风格，不要随意创建新的注释风格。

2.注释准确简洁

内容要简单、明了，防止注释的多义性，错误的注释不但无益反而有害。

二、注释条件：

1.基本注释（必须加）

a)类（接口）的注释

b)构造函数的注释

c)方法的注释

d)全局变量的注释

e)字段/属性的注释

Java基础学习总结（36）——Java注释模板相关推荐

java基础学习总结一(java语言发展历史、jdk的下载安装以及配置环境变量)
最近一段时间计划复习一下java基础知识,使用的视频课程是尚学堂高淇老师的,上课过程中的心得体会直接总结一下,方便以后复习. 一:计算机语言的发展 1:机器语言,最原始的语言,主要有"01 ...
Java基础学习笔记三 Java基础语法
Scanner类 Scanner类属于引用数据类型,先了解下引用数据类型. 引用数据类型的使用与定义基本数据类型变量不同,引用数据类型的变量定义及赋值有一个相对固定的步骤或格式. 数据类型变量名 ...
Java基础学习总结(50)——Java事务处理总结
一.什么是Java事务通常的观念认为,事务仅与数据库相关. 事务必须服从ISO/IEC所制定的ACID原则.ACID是原子性(atomicity).一致性(consistency).隔离性(isol ...
java中哪些可以私有化_《Java基础学习笔记》JAVA修饰符之私有化(Private)
1,什么是private修饰符? private是权限修饰符,用于修饰类中的成员(成员变量,成员函数). private修饰后的成员只在本类中有效. /* 例: * 将age私有化以后,类以外即使建立 ...
《Java基础学习笔记》JAVA面向对象之封装
1,封装,是指隐藏对象的属性和实现细节,仅对外提供公共访问方式. 2,好外: a)将变化隔离. b)便于使用. c)提高重用性. d)提高安全性 ...
Java 基础学习-Java语言概述
Java 基础学习第一章 Java语言概述回顾java基础知识,进行整理记录. 文章目录 Java 基础学习前言一. Java语言发展史(了解) 二.Java语言跨平台原理(理解) 三.JRE ...
Java基础学习笔记（完结）
Java基础前言一.Java基础语法 1.注释 2.标识符 3.数据类型 4.类型转换 5.变量.作用域.常量 6. 运算符二.Scanner与流程控制 1. Scanner对象 2. 流程控制 ...
JAVA基础学习精简心得笔记整理
JAVA基础学习精简心得笔记整理配置java环境变量 Java的运行过程基本数据类型引用数据类型逻辑运算符数组方法重载封装继承多态多态的作用单例设计模式接口interface ...
【Java基础学习笔记】- Day11 - 第四章引用类型用法总结
Java基础学习笔记 - Day11 - 第四章引用类型用法总结 Java基础学习笔记 - Day11 - 第四章引用类型用法总结 4.1 class作为成员变量 4.2 interface作为成 ...
【读书笔记】Java基础学习之目录
前述 :本人目前正在学习java,开发Android应用,因此重新来把java学习一遍. 本文所有资料来源于互联网,我将根据自己的学习进度,不断的将资料整合,就当作是读书笔记吧! 本文作为目录页,将不 ...

Java基础学习总结（36）——Java注释模板

Java基础学习总结（36）——Java注释模板相关推荐

最新文章

热门文章