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

常用的javadoc标记有以下几种:

[email protected] 程序的作者说明

[email protected] 源文件的版本说明

[email protected] 方法的参数说明

[email protected] 不建议的使用方法

[email protected] 方法的返回值的说明信息

[email protected] 参见,用于指定参考内容

[email protected] 抛出的异常类型

[email protected] 抛出的异常

可以出现在类或者接口文档注释中的:@see,@deprecated,@author,@version等

可以出现在方法和构造器中的有: @see,@deprecated,@param,@return,@exception,@throws等

可以出现在成员变量中有:@see,@deprecated等

String API

一、获取:

int  length():获取字符串的长度。

char  charAt( int  index )根据位置获取该位置上某个字符:

根据字符获取该字符在字符串中的位置:

int  indexOf(int ch):返回的是ch在字符串中第一次出现的的位置。

int  indexOf(int ch,int fromIndex):从fromIndex指定位置开始,获取ch在字符串中出现的位置。

int  indexOf(String str):返回的是str在字符串中第一次出现的的位置。

int  indexOf(String str,int fromIndex):从fromIndex指定位置开始,获取str在字符串中出现的位置。

int  lastIndexOf(xx,xx):里面的参数与上面的4中方法一致。但是是从后面开始查找。

二、判断:

boolean  contains(str):字符串中是否包含某一个字符串。

特例indexOf(str):可以索引str第一次出现位置,如果返回-1,表示该str不在字符串中存在。即用该方法就可以判断是否包含某一个字符串。而且可以返回出现的位置。

boolean  isEmpty():字符中是否有内容。

boolean  startsWith(str):字符串是否是以指定内容开头。

boolean  endsWith(str):字符串是否是以指定内容结尾。

boolean  equals(str):判断字符串内容是否相等。复写了Object类中的equals()方法。

boolean  equalsIgnoreCase(str):判断字符串内容是否相同,并忽略大小写。

三、转换:

将字符数组转换成字符串。

构造函数String(char [])  将字符数组转换成字符串。

String(char [],offset,count)  将字符数组中的一部分转换成字符串。

静态方法:static copyValueOf(char [] data)

static copyValueOf(char [] data,int  offset , int count)

将字符串转换成字符数组。**

char []  toCharArray();

将字节数组转换成字符串。

构造函数String(byte [])  将字节数组转换成字符串。

String(byte [],offset,count)  将字节数组中的一部分转换成字符串。

将字符串转换成字符数组。

byte []  getBytes();

将基本数据类型转换成字符串。

static String valueOf(基本数据类型)

特殊注意:字符串和字节数组在转换过程中,是可以指定编码表的。

四、替换:

String replace(oldChar,newChar); 如果要替换的字符不存在,则返回的还是原串。单引号。

String replace(oldCharSequence,newCharSequence); 如果要替换字符串不存在,返回原串。双引号。

五、切割:

String [] split(regex); 参数为指定的字符串。

六、子串:

String substring(begin);  获取字符串中的一部分。从指定的位置开始。

String substring(begin,end);  获取字符串中的一部分。从指定的位置开始,到指定的位置前一位结束

其他:

String toUpperCase():将字符串转换成大写。

String toLowerCase():将字符串转换成小写。

String trim():将字符串两端的多个空格去除。

int compareTo(String )对两个字符串进行自然顺序的比较。

时间: 2024-08-06 00:12:54

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

C#中的XML文档注释-推荐的文档注释标记

文档注释是为了方便自己和他人更好地理解代码所实现的功能.下面记录了一些常用的文档注释标记: <C> 用法: <c>text</c> 将说明中的文本标记为代码.例如: /// <summary> /// Validates the user. /// </summary> /// <param name="username">The username.</param> /// <param name

[java基础]文档注释

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

Java的文档注释之生成帮助文档

示例: /** * Title: Person类<br/> * Description:通过Person类说明Java中的文档注释<br/> * Company: *** * @author *** * @version 1.0 */ public class Person { /** * 这个是Person类的构造方法 * @param name Person 的名字 * */ public Person(String name) { //执行语句: } /** * 这是read

Java 文档注释

Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息,并输出到HTML文件中. 说明注释,是你更加方面的记录你的程序的信息. javadoc 标签 javadoc工具软件识别以下标签: 标签 描述 示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @deprecated de

java文档注释主要使用方法

一.java包含哪些注释 1.//用于单行注释. 2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套. 3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句.这个也就是我们所知的文档注释 在命名控制台:使用命令行在目标文件所在目录输入javadoc +文件名.java. 二.文档注释的关键名词 /**<p>标记 用于 作用</p> * @author 类或方法 一般用于描述开放者 * @version 类 版本说明 * @see 对类.属性.

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格式的代码报告,所以注释文档必须书写在类.域.构造函数.方法.定义之前.注释文档由两部分组成—

如何为我们的程序编写开发文档——Java文档注释

Java文档注释是用于生成Java API文档的注释,通过在程序中的类.属性.方法部分加上注释,就可以用javadoc命令生成漂亮的API文档,是程序员进阶的必备技能. 注意,文档注释只说明紧跟其后的类.属性或者方法. Javadoc文档生成命令为: -author和-version可以省略. 根据在文档中显示的效果,文档注释分为三部分.举例如下: 第一部分是简述.如下图中被红框框选的部分: 简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号). 第二部分是详细说明部分.该部

Java - 34 Java 文档注释

Java 文档注释 Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息,并输出到HTML文件中. 说明注释,使你更加方便的记录你的程序的信息. javadoc 标签 javadoc工具软件识别以下标签: 标签 描述 示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @dep

Java基础入门 - 三种注释及文档注释详解

类似C/C++,Java也支持单行和多行注释 注释中的字符在编译时会被忽略 注释通常为类.变量和方法的主要描述 单行注释 // 注释内容 多行注释 /* 注释内容 */ /* * 注释内容 */ 文档注释 /** * 注释内容 */ 文档注释可使用javadoc工具来生成信息,并输出到HTML文件中,方便记录程序信息 文档注释中可包含一个或多个@标签,每个@标签都在新的一行开始 多个相同的标签应一个接一个的放在一起组成一组 实例:SquareNum.java import java.io.*;