学习笔记DAY4
2022/6/12 23:23:24
本文主要是介绍学习笔记DAY4,对大家解决编程问题具有一定的参考价值,需要的程序猿们随着小编来一起学习吧!
这里先补充一下昨天的文档注释
3.文档注释 基本格式:/** * */ 应用实例: 代码: /** * @author 王聪 * @version 1.0 */ //演示文档注释使用 public class Comment02 { //编写一个main方法 public static void main (String[] args) { } } DOS命令行: 刚开始一堆报错如下图 将编码转为UTF-8编码后错误解决,然后再次使用javadoc工具 DOS中显示正在生成,但是temp文件夹下没有文件生成 想了想可能是文件夹书写格式不行,于是将 d:\\temp 改写成了 D:\temp ,然后正常生成了相应的html文件 文件夹下有文件生成: 这里打开Comment02.html看一下效果 常见javadoc标签:标签 | 说明 | JDK 1.1 doclet | 标准doclet | 标签类型 |
@author 作者 | 作者标识 | √ | √ | 包、 类、接口 |
@version 版本号 | 版本号 | √ | √ | 包、 类、接口 |
@param 参数名 描述 | 方法的入参名及描述信息,如入参有特别要求,可在此注释。 | √ | √ | 构造函数、 方法 |
@return 描述 | 对函数返回值的注释 | √ | √ | 方法 |
@deprecated 过期文本 | 标识随着程序版本的提升,当前API已经过期,仅为了保证兼容性依然存在,以此告之开发者不应再用这个API。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
@throws异常类名 | 构造函数或方法所会抛出的异常。 | √ | 构造函数、 方法 | |
@exception 异常类名 | 同@throws。 | √ | √ | 构造函数、 方法 |
@see 引用 | 查看相关内容,如类、方法、变量等。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
@since 描述文本 | API在什么程序的什么版本后开发支持。 | √ | √ | 包、类、接口、值域、构造函数、 方法 |
{@link包.类#成员 标签} | 链接到某个特定的成员对应的文档中。 | √ | 包、类、接口、值域、构造函数、 方法 | |
{@value} | 当对常量进行注释时,如果想将其值包含在文档中,则通过该标签来引用常量的值。 | √(JDK1.4) | 静态值域 |
- 类、方法的注释,要以 javadoc 的方式来写。
- 非javadoc的注释,往往是给代码的维护者看的,着重告诉读者为什么这样写,如何修改,注意什么问题等
- 使用 Tab 操作,实现缩进,默认整体向右边移动,或者用 Shift + Tab 整体左移
- 运算符和 = 两边习惯性各加一个空格。比如:2 + 4 * 5 - 3
- 源文件使用UTF-8编码
- 行宽度不要超过80字符
- 代码编写行尾风格和次行风格
- 查看当前目录有什么
- 切换到其他盘下:盘符号 cd
- 切换到当前盘的其他目录下(使用相对路径和绝对路径演示)
- 切换到上一级
- 切换到根目录:cd\
- 查看指定目录下所有的子级目录
- 清屏 cls
- 退出DOS exit
- md【创建目录】;rd【删除目录】;copy【拷贝文件】;del【删除文件】;echo【输入内容到文件并创建了该文件】;type;move【剪切】
这篇关于学习笔记DAY4的文章就介绍到这儿,希望我们推荐的文章对大家有所帮助,也希望大家多多支持为之网!
- 2024-05-15鸿蒙生态设备数量超8亿台
- 2024-05-13TiDB + ES:转转业财系统亿级数据存储优化实践
- 2024-05-09“2024鸿蒙零基础快速实战-仿抖音App开发(ArkTS版)”实战课程已上线
- 2024-05-09聊聊如何通过arthas-tunnel-server来远程管理所有需要arthas监控的应用
- 2024-05-09log4j2这么配就对了
- 2024-05-09nginx修改Content-Type
- 2024-05-09Redis多数据源,看这篇就够了
- 2024-05-09Google Chrome驱动程序 124.0.6367.62(正式版本)去哪下载?
- 2024-05-09有没有大佬知道这种数据应该怎么抓取呀?
- 2024-05-09这种运行结果里的10.100000001,怎么能最快改成10.1?