Java包机制与IDEA生成doc文档

本文档介绍了Java的包机制,遵循阿里巴巴开发手册的包命名规范,并展示了如何使用`import`导入包。此外,详细讲解了如何使用JavaDoc生成API文档,包括在IDEA中生成及通过命令行操作。示例代码中包含了类注释和方法注释的格式。遵循良好的编码习惯,可以提高代码的可读性和维护性。
摘要由CSDN通过智能技术生成

Java包机制

package //建立包

一般用公司域名倒置作为包名 www.baidu.com->com.baidu.www

import //导入包
import com.LittleWu.Operator.*;  //xxx.* 通配符 导入这个包下所有的类

阿里巴巴开发手册->推荐

生成doc文档

以下是doc文件底层代码
加在类上面是类的注释
加载方法上面是方法的注释

package com.LittleWu.Base;

/***
 * ░░░░░░░░░░░░░░░░░░░░░░░░▄░░
 * ░░░░░░░░░▐█░░░░░░░░░░░▄▀▒▌░
 * ░░░░░░░░▐▀▒█░░░░░░░░▄▀▒▒▒▐
 * ░░░░░░░▐▄▀▒▒▀▀▀▀▄▄▄▀▒▒▒▒▒▐
 * ░░░░░▄▄▀▒░▒▒▒▒▒▒▒▒▒█▒▒▄█▒▐
 * ░░░▄▀▒▒▒░░░▒▒▒░░░▒▒▒▀██▀▒▌
 * ░░▐▒▒▒▄▄▒▒▒▒░░░▒▒▒▒▒▒▒▀▄▒▒
 * ░░▌░░▌█▀▒▒▒▒▒▄▀█▄▒▒▒▒▒▒▒█▒▐
 * ░▐░░░▒▒▒▒▒▒▒▒▌██▀▒▒░░░▒▒▒▀▄
 * ░▌░▒▄██▄▒▒▒▒▒▒▒▒▒░░░░░░▒▒▒▒
 * ▀▒▀▐▄█▄█▌▄░▀▒▒░░░░░░░░░░▒▒▒
 * 单身狗就这样默默地看着你,一句话也不说。
 */

/**
 * @author littleWu
 * @version 1.0
 * @since 1.8
 *
 */
public class Doc {
    String name;

    /**
     *
     * @param name
     * @return
     * @throws Exception
     */
    public String test(String name) throws Exception{
        return name;
        // 命令行操作 命令代码 javaDoc 参数 java文件
        // 面向百度编程!!!

    }
}

若IDEA想生成javadoc文件 可以选择show in Explorer 打开文件所在地
并通过在文档地址前+cmd在命令行打开 并输入命令代码
命令代码格式为:命令代码 javaDoc 参数 java文件
例:

javaDoc -encoding utf-8 -charest utf-8 doc.java

而如果要在IDEA内源码生成doc文档
则可以打开tools-Generate javadoc…
并按照页面加载
在这里插入图片描述
即可生成 若生成失败则可以去选定的目录下打开index.html文件即可打开

  • 1
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 3
    评论
评论 3
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值