javaOO——引用数据类型数组与文档注释

引用数据类型的数组:

  1、引用数据类型数组在语法上和基本数据类型是没有区别的

  2、引用类型变量可以使用类、接口或数组来声明。

  3、数组引用变量是存放在栈内存(stack)中,数组元素是存放在堆内存(heap)中,通过栈内存中的指针指向对应元素在堆内存中的位置来实现访问。

文档注释:

【文档注释】是写在类、方法、成员变量的上面的。

文档注释可以用eclipse导出chm格式的帮助文档,拿给其他人用时,方便他人理解。文档注释被调用的方法,当鼠标移到上面时提醒注释内容。

使用文档注释时,需要在开始的 /** 之后,第一行或几行是关于类、变量和方法的主要描述。

之后,可以包含一个或多个何种各样的@ 标签。每一个@标签必须在一个新行的开始或者在一行的开始紧跟星号(*)。多个相同类型的标签应该放成一组。

文档注释生成帮助文档的步骤:

1、点击projec——>Generate javadoc...

2、选择你所要生成的文件

3、点击下一步,再点击下一步。若编码是utf-8则需要输入-encoding utf-8 -charset utf-8,点击完成

4、打开index.html

原文地址:https://www.cnblogs.com/libobo22/p/11609403.html

时间: 2024-10-12 02:22:56

javaOO——引用数据类型数组与文档注释的相关文章

java笔记------文档注释标记,String相关的API

常用的javadoc标记有以下几种: [email protected] 程序的作者说明 [email protected] 源文件的版本说明 [email protected] 方法的参数说明 [email protected] 不建议的使用方法 [email protected] 方法的返回值的说明信息 [email protected] 参见,用于指定参考内容 [email protected] 抛出的异常类型 [email protected] 抛出的异常 可以出现在类或者接口文档注释中

C# XML 文档注释文件格式

在编写 C# 代码时,只要在注释按照格式加入 XML 文档注释,例如: /// <summary> /// 这里是类的注释. /// </summary> public class MyClass { } 就可以通过设置项目的"属性->生成->输出->XML 文档文件",来为当前项目生成包含所有文档注释的 XML 文件.一般可用于 Visual Studio 的智能提示,或者利用 Sandcastle 等工具生成文档. 下面,我会介绍生成的 X

java文档注释 编写格式

java 文档注释 在sun主页上有java文档注释的编写格式 How to Write Doc Comments for the Javadoc Tool http://java.sun.com/j2se/javadoc/writingdoccomments/ 不过是英文的 @author dfeixtay @version 0.10 2010-10-04 1 注释文档的格式注释文档将用来生成HTML格式的代码报告,所以注释文档必须书写在类.域.构造函数.方法.定义之前.注释文档由两部分组成—

C# 字符串操作,可空类型,文档注释,嵌套类型

字符串 字符串是Unicode字符串数组,且是不可变的 这种操作不会影响到原来的字符串,它会新添加一个副本. 有关Split的操作 using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Reflection; using System.Runtime.CompilerServices; usin

C#6.0语言规范(十九) 文档注释

C#为程序员提供了一种机制,可以使用包含XML文本的特殊注释语法来记录他们的代码.在源代码文件中,具有特定形式的注释可用于指示工具从这些注释和它们之前的源代码元素生成XML.使用这种语法的注释称为文档注释.它们必须紧接在用户定义的类型(例如类,委托或接口)或成员(例如字段,事件,属性或方法)之前.XML生成工具称为文档生成器.(这个生成器可以是,但不一定是C#编译器本身.)文档生成器生成的输出称为文档文件.文档文件用作a的输入文档查看器 ; 用于生成类型信息及其相关文档的某种视觉显示的工具. 此

[java基础]文档注释

转载自:http://blog.163.com/hui_san/blog/static/5710286720104191100389/ 前言 Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗? 1)// 注释一行   2)/* ...... */ 注释若干行 3)/** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /**   * .........   * .........   */ 这第三种注释有什么用?javado

.NET中的注释种类,单行注释、多行注释、文档注释。。。

注释不是给编译器看的,而是给程序员看的.是程序员之间交流的一种方式.好的程序员一定要有完善的注释. .NET注释类型. 1.单行注释  // a.当代码行比较短时,注释可以放在代码后面. b.当代码行比较长时,注释一定要放在注释代码上边,而不是下边. c.快捷键:选中要注释的代码, 注释: ctrl k +ctrl c 取消注释:ctrl k + ctrl u 2.多行注释  /*  */ a.多行注释不能嵌套. 3.文档注释  /// a.快捷键 在方法头.类 .枚举.接口上边 连续输入 三个

静态的应用与文档注释

一.静态的应用一: 比如数组工具类: 每个应用程序中都有共性的功能,可以将这些功能进行抽取,独立封装以便复用 虽然可以通过建立ArrayTool的对象使用这些工具方法对数组进行操作 但是: 1.对象是用于封装数据的,可是ArrayTool对象并没封装特有数据(没有成员变量). 2.操作数组的每一个方法都没有用到ArrayTool对象中的特有数据 这时就考虑,让程序更严谨,是不需要对象的,可以将ArrayTool中的方法都定义成static的,直接用类名调用 将方法都静态后,可以方便于使用,但是该

[转]Eclipse 的快捷键以及文档注释、多行注释的快捷键

一.多行注释快捷键 1.选中你要加注释的区域,用ctrl+shift+C 或者ctrl+/ 会加上//注释 2.先把你要注释的东西选中,用shit+ctrl+/ 会加上/*    */注释 3.以上快捷在重复按一下就会去掉加上的注释 4.要修改在eclispe中的命令的快捷键方式我们只需进入windows -> preference -> General -> key设置就行了 二.Eclipse中添加文档注释快捷键 1.例如默认的文档注释: /** * @author XX * */