maven打jar,doc文档,source包

版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/zhangjingao/article/details/81942421

maven打jar,doc文档,source包

在项目开发中,这次用到了sdk封装,所以需要把maven项目打成jar包,并且需要doc文档。
打jar包本身是没有特殊要求的,看具体的使用场景,如果你是开源项目,你的jar包里呢还需要由注释,那么普通的jar就不行了,你需要打source包(也是一种jar包),如果你是私人项目注重项目隐私的话,那你就打普通的jar包就好,防止泄露太多信息。

普通jar包

pom文件

<build>
       <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>utf8</encoding>
                </configuration>
            </plugin>
       </plugins>
 </build>

打开cmd,进入到项目根目录输入mvn install,就会发现在根目录下生成target包,里面就会有你的jar包。

doc包

对于doc包,咱们很多人都用过,对于一个开源项目,doc文档很重要,那么我们需要生成doc文档,生成doc文档呢就需要你会doc的语法和格式要求有一定了解,不能有多余的注解,必须要有的注解也有要。可以进入教程看下,很简单:点此进入doc教程

pom文件

    <!-- 标明utf-8编码 -->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <maven.compiler.encoding>UTF-8</maven.compiler.encoding>
    </properties>

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-compiler-plugin</artifactId>
                <configuration>
                    <source>1.8</source>
                    <target>1.8</target>
                    <encoding>utf8</encoding>
                </configuration>
            </plugin>
            <!-- 生成doc文档 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>


        </plugins>

    </build>

打开cmd,进入到项目根目录输入mvn install,就会发现在根目录下生成target包,里面有jar包,除此之外还有apidoc这个目录,点进去,里面有很多html,找到index.html,使用浏览器打开。
这里写图片描述
这就是你的doc文档了

source包

如果是开源项目,那么你的代码里还要有注释,那么就打source包。
pom文件

    <build>
        <plugins>
            <!-- source包 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-source-plugin</artifactId>
                <version>3.0.0</version>
                <configuration>
                    <attach>true</attach>
                </configuration>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
            <!-- 生成doc文档 -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

同样的方式,打开cmd,进入到项目根目录输入mvn install,就会在target下生成source包,直接导普通的包就可以了,也会带有注释。

猜你喜欢

转载自blog.csdn.net/zhangjingao/article/details/81942421