Создание jar файла с комментариями кода

132
02 октября 2019, 16:50

Я написал свою маленькою библиотеку, все методы и переменние коментировал.

Когда я скомпилировал jar, подключил его к проекту, и декомпилил, все комментарии пропали.

Как создать jar с комментариями? Про генерацию javadoc знаю, нужно именно комментарии.

Answer 1

При сборке проекта Maven есть специальный плагин, который собирает javadoc во время сборки нужно добавить в pom.xml

<dependencies>
...
       <!--
            Maven Javadoc Plugin
            Javadocs provide documentation that makes it easier for developers to know
            how to use a particular class. Instead of reading and understanding the
            actual source code, the developer can use the Javadocs instead to lookup
            the class attributes and methods.
        -->
        <dependency>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-javadoc-plugin</artifactId>
            <version>3.0.0</version>
        </dependency>
...
</dependencies>

используем плагин при сборке проекта

<build>
   ...
   <plugins>
      ...
      <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.0.0</version>
                <configuration>
                    <docencoding>UTF-8</docencoding>
                </configuration>
                <executions>
                    <execution>
                        <id>attach-javadocs</id>
                        <goals>
                            <goal>jar</goal>
                        </goals>
                    </execution>
                </executions>
      </plugin>
      ...
   </plugins>
</build>

добавляем раздел

<reporting>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
                <version>3.0.0</version>
                <configuration>
                    <docencoding>UTF-8</docencoding>
                </configuration>
            </plugin>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jxr-plugin</artifactId>
                <version>2.5</version>
            </plugin>
        </plugins>
</reporting>

это создаст jar-файл с документацией. Дальше Maven надо указать загружать зависимости с документацией, в Идеи в идеи это выглядит так

Аналогичный плагин есть для сборки архива с кодом maven-source-plugin. Подробнее смотри в документации Maven.

READ ALSO
ссылка одного CSS внутри другого CSS

ссылка одного CSS внутри другого CSS

Вопрос чисто теоретический и простой, но в интернетах не нашелКак реализовать вот это:

121
Как вырезать два небольших сегмента из окружности и вращать их при наведении курсора

Как вырезать два небольших сегмента из окружности и вращать их при наведении курсора

На многих сайтах стали появляться эффекты вращения окружностей с симметрично вырезанными небольшими участкамиСмотрится хорошо

150
HTML5 Canvas анимация

HTML5 Canvas анимация

Возникла такая трудность вывожу на экран(в canvas html5) массив объектов, и мне как то надо задать этим объектам разную скорость вращенияКак это...

125
Vue, vuetify и список для справочников

Vue, vuetify и список для справочников

Есть вот такой интерфейсСлева справочники, вот думаю как сделать чтобы там был список справочников, чтобы пользователь мог выбрать любой...

129