2024-06-10

weibiansanjue · Jun 9, 2024 · b2904da · b2904da
1 parent e676211
commit b2904da
Show file tree

Hide file tree

Showing 4 changed files with 58 additions and 7 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -8,10 +8,10 @@ jobs:
     name: Publish Logseq graph
     steps:
       - uses: actions/checkout@v3
-      - uses: logseq/publish-spa@v0.2.0
+      - uses: logseq/publish-spa@v0.3.1
       - name: add a nojekyll file # to make sure asset paths are correctly identified
         run: touch $GITHUB_WORKSPACE/www/.nojekyll
       - name: Deploy 🚀
         uses: JamesIves/github-pages-deploy-action@v4
         with:
-          folder: www
+          folder: www
diff --git a/journals/2023_11_27.md b/journals/2023_11_27.md
@@ -1 +1,2 @@
-- [[Java 反编译工具]]
+- [[Java 反编译工具]]
+- [[在 Javadoc 中排除类或方法]]
diff --git a/pages/macOS IntelliJ IDEA SpringBoot 启动超慢.md b/pages/macOS IntelliJ IDEA SpringBoot 启动超慢.md
@@ -1,5 +1,7 @@
 tags:: [[tagIntelliJIDEA]]
 
+via:: [Idea突然启动SpringBoot项目变的很慢](https://blog.csdn.net/ai249841929/article/details/131181254), [Mac IDEA启动SpringBoot项目过慢](http://81.70.159.205/2019/05/06/IdeaSpringBoot/)
+
 - 版本
 	- macOS：`13.4.1 (22F82)`
 	- IntelliJ IDEA：`2023.1.3 (Ultimate Edition)，Build #IU-231.9161.38, built on June 20, 2023`
@@ -26,7 +28,4 @@ tags:: [[tagIntelliJIDEA]]
 	  #修改条目如下，注意分隔符是TAB，不是空格
 	  127.0.0.1	localhost	xxMacBook-Pro.local
 	  ::1     localhost	xxxMacBook-Pro.local
-	  ```
-- 参考资料
-	- [Idea突然启动SpringBoot项目变的很慢](https://blog.csdn.net/ai249841929/article/details/131181254)
-	- [Mac IDEA启动SpringBoot项目过慢](http://81.70.159.205/2019/05/06/IdeaSpringBoot/)
+	  ```
diff --git a/pages/在 Javadoc 中排除类或方法.md b/pages/在 Javadoc 中排除类或方法.md
@@ -0,0 +1,51 @@
+tags:: [[tagJavadoc]], [[tagJava]]
+
+- ## 前言
+	- 可以使用 Maven 插件 [`org.apache.maven.plugins:maven-javadoc-plugin`](https://maven.apache.org/plugins/maven-javadoc-plugin/index.html) 生成项目 Javadoc
+	- 为了使文档更加简洁，降低阅读难度，我们可以将一些不重要内容在文档中进行排除
+- ## 方法
+	- 排除`包`
+		- 在插件配置中设置 `<excludePackageNames>` 标签，并将需要排除的包路径写在标签内
+			- [Apache Maven Javadoc Plugin – Excluding Packages](https://maven.apache.org/plugins/maven-javadoc-plugin/examples/exclude-package-names.html)
+			- [Apache Maven Javadoc Plugin – javadoc:javadoc](https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#excludePackageNames)
+	- `@Deprecated` 排除`类`或`方法`
+		- 如果需要发布已废弃的类或方法，可以使用 `<nodeprecated>true|false</nodeprecated>` 标记
+			- [Apache Maven Javadoc Plugin – javadoc:javadoc](https://maven.apache.org/plugins/maven-javadoc-plugin/javadoc-mojo.html#nodeprecated)
+	- `@hidden` 排除`类`或`方法`
+		- JDK >= 1.9
+		- 在类或方法的 Javadoc 中使用
+		- 如果当前项目 JDK < 1.9，可以使用项目外部高版本 JDK 进行 Javadoc 的生成
+			- [Apache Maven Javadoc Plugin – Using Alternate Javadoc Tool](https://maven.apache.org/plugins/maven-javadoc-plugin/examples/alternate-javadoc-tool.html)
+- ## 示例
+	- ```xml
+	  <project>
+	    ...
+	    <build>
+	      <plugins>
+	        <plugin>
+	          <groupId>org.apache.maven.plugins</groupId>
+	          <artifactId>maven-javadoc-plugin</artifactId>
+	          <version>3.7.0</version>
+	          <configuration>
+	            <encoding>UTF-8</encoding>
+	  		  <charset>UTF-8</charset>
+	  		  <docencoding>UTF-8</docencoding>
+	  		  <!-- 使用外部 javadoc 命令，使高版本 jdk 才支持的 @hidden 文档注释生效
+	  		       在系统里设置高版本 JDK 环境变量，例如 ${JAVA21_HOME}
+	                 添加完环境变量后，需要重启 IDEA 才生效 -->
+	  		  <javadocExecutable>${env.JAVA21_HOME}/bin/javadoc</javadocExecutable>
+	  		  <!-- 排除不需要生成文档的包 -->
+	  		  <excludePackageNames>
+	  			*.internal:org.acme.exclude1.*:org.acme.exclude2
+	  		  </excludePackageNames>
+	  		  <!-- 文档中不生成 @Deprecated 标注废弃的类 -->
+	  		  <nodeprecated>true</nodeprecated>
+	            ...
+	          </configuration>
+	        </plugin>
+	      </plugins>
+	      ...
+	    </build>
+	    ...
+	  </project>
+	  ```