diff --git a/docs/.vitepress/cache/deps/@theme_index.js b/docs/.vitepress/cache/deps/@theme_index.js index d467d54..a75e96a 100644 --- a/docs/.vitepress/cache/deps/@theme_index.js +++ b/docs/.vitepress/cache/deps/@theme_index.js @@ -9,31 +9,31 @@ import { } from "./chunk-HMY2GJYS.js"; // node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/index.js -import "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/fonts.css"; +import "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/fonts.css"; // node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/without-fonts.js -import "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/vars.css"; -import "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/base.css"; -import "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/utils.css"; -import "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/custom-block.css"; -import "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/vp-code.css"; -import "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/vp-code-group.css"; -import "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/vp-doc.css"; -import "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/vp-sponsor.css"; -import VPBadge from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPBadge.vue"; -import Layout from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/Layout.vue"; -import { default as default2 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPBadge.vue"; -import { default as default3 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPImage.vue"; -import { default as default4 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPButton.vue"; -import { default as default5 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPHomeHero.vue"; -import { default as default6 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPHomeFeatures.vue"; -import { default as default7 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPHomeSponsors.vue"; -import { default as default8 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPDocAsideSponsors.vue"; -import { default as default9 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPSponsors.vue"; -import { default as default10 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPTeamPage.vue"; -import { default as default11 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPTeamPageTitle.vue"; -import { default as default12 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPTeamPageSection.vue"; -import { default as default13 } from "G:/AST/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPTeamMembers.vue"; +import "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/vars.css"; +import "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/base.css"; +import "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/utils.css"; +import "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/custom-block.css"; +import "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/vp-code.css"; +import "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/vp-code-group.css"; +import "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/vp-doc.css"; +import "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/styles/components/vp-sponsor.css"; +import VPBadge from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPBadge.vue"; +import Layout from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/Layout.vue"; +import { default as default2 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPBadge.vue"; +import { default as default3 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPImage.vue"; +import { default as default4 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPButton.vue"; +import { default as default5 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPHomeHero.vue"; +import { default as default6 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPHomeFeatures.vue"; +import { default as default7 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPHomeSponsors.vue"; +import { default as default8 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPDocAsideSponsors.vue"; +import { default as default9 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPSponsors.vue"; +import { default as default10 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPTeamPage.vue"; +import { default as default11 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPTeamPageTitle.vue"; +import { default as default12 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPTeamPageSection.vue"; +import { default as default13 } from "G:/Project_MCFPP/MCFPPAPI/node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/components/VPTeamMembers.vue"; // node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/shared.js var inBrowser = typeof document !== "undefined"; diff --git a/docs/.vitepress/cache/deps/_metadata.json b/docs/.vitepress/cache/deps/_metadata.json index 68b1675..0c53fa6 100644 --- a/docs/.vitepress/cache/deps/_metadata.json +++ b/docs/.vitepress/cache/deps/_metadata.json @@ -1,49 +1,49 @@ { - "hash": "24352143", - "configHash": "bd1e298f", + "hash": "cc4aaa53", + "configHash": "c7e68496", "lockfileHash": "657949f7", - "browserHash": "275bbd23", + "browserHash": "eaee6cc0", "optimized": { "vue": { "src": "../../../../node_modules/.pnpm/vue@3.4.15/node_modules/vue/dist/vue.runtime.esm-bundler.js", "file": "vue.js", - "fileHash": "dec94417", + "fileHash": "1ad5d986", "needsInterop": false }, "vitepress > @vue/devtools-api": { "src": "../../../../node_modules/.pnpm/@vue+devtools-api@7.0.14/node_modules/@vue/devtools-api/dist/index.js", "file": "vitepress___@vue_devtools-api.js", - "fileHash": "c3f51ca5", + "fileHash": "7578b930", "needsInterop": false }, "vitepress > @vueuse/core": { "src": "../../../../node_modules/.pnpm/@vueuse+core@10.7.2_vue@3.4.15/node_modules/@vueuse/core/index.mjs", "file": "vitepress___@vueuse_core.js", - "fileHash": "6ec7a515", + "fileHash": "731427e6", "needsInterop": false }, "vitepress > @vueuse/integrations/useFocusTrap": { "src": "../../../../node_modules/.pnpm/@vueuse+integrations@10.7.2_focus-trap@7.5.4_vue@3.4.15/node_modules/@vueuse/integrations/useFocusTrap.mjs", "file": "vitepress___@vueuse_integrations_useFocusTrap.js", - "fileHash": "13de43f6", + "fileHash": "e8e1179a", "needsInterop": false }, "vitepress > mark.js/src/vanilla.js": { "src": "../../../../node_modules/.pnpm/mark.js@8.11.1/node_modules/mark.js/src/vanilla.js", "file": "vitepress___mark__js_src_vanilla__js.js", - "fileHash": "2279df2d", + "fileHash": "651eef88", "needsInterop": false }, "vitepress > minisearch": { "src": "../../../../node_modules/.pnpm/minisearch@6.3.0/node_modules/minisearch/dist/es/index.js", "file": "vitepress___minisearch.js", - "fileHash": "eb264697", + "fileHash": "4ebbb488", "needsInterop": false }, "@theme/index": { "src": "../../../../node_modules/.pnpm/vitepress@1.0.0-rc.41_@algolia+client-search@4.22.1_search-insights@2.13.0/node_modules/vitepress/dist/client/theme-default/index.js", "file": "@theme_index.js", - "fileHash": "2872f18a", + "fileHash": "37aaf77b", "needsInterop": false } }, diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index 86d0533..01c49d4 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -819,7 +819,11 @@ export default defineConfig({ { text: '主页', link: '/zh/' }, { text: '快速开始', link: '/zh/quickstart/index' }, { text: '文档', link: '/mcfppdocs/index.html' } - ] + ], + footer: { + message: "MCICP备2024000011号", + copyright: "GPL-3.0 Lisenced | Copyright©2024 ProjectMCFPP" + } } }, en : { diff --git a/docs/index.md b/docs/index.md index b7885d8..2e959a6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,5 +21,5 @@ features: details: 一份代码，多版本支持，无需担心Mojang的一周一改 - title: 无缝集成 details: 强大的MNI框架，基于数据包编译期，提供更多的可能 ---- +--- diff --git a/docs/zh/quickstart/13doc/01doc-comment.md b/docs/zh/quickstart/13doc/01doc-comment.md new file mode 100644 index 0000000..4adbe4e --- /dev/null +++ b/docs/zh/quickstart/13doc/01doc-comment.md @@ -0,0 +1,74 @@ +--- +lastUpdated: true +--- + +# 文档注释未来特性 + +作为MCFPP中的第三种注释，文档注释可以用来给你的项目自动生成一份文档。MCFPP的文档注释是标签语法和Markdown的混合体，你可以使用标签注释来提供必要的关键信息，同时用Markdown来书写详细的文档内容。 + +## 语法 + +文档注释使用`#{`开头，以`#}`结束，其中即为文档注释。文档注释的每一行可以使用`#`开头，`#`不会被作为注释的一部分。 + +标签注释必须写在Markdown之前。 + +文档注释可以写在任何声明的上方，但是局部变量的文档注释不会被提取到生成的文档中，仅用于IDE的提示。 + +以下是一个文档注释的例子： + +```mcfpp + +#{ + @base 苦力怕 + + 超级苦力怕的实现类 +}# +@Base<"creeper"> +class SuperCreeper{ + + #{ + 苦力怕会给予的效果列表 + }# + list effectList = ["wither", "poison", "slowness", "hunger", "blindness", "weakness"]; + + #{ + @return 一个随机效果 + + 获取一个随机效果 + }# + func getEffect() -> string { + return effectList.random(); + } + + override func tick(){ + if(@a[distance = 0..5].exist()){ + effect(@a[distance = 0..5], getEffect(), 1, 10); + } + } + +} +``` + +## 标签 + +有些标签只能用于实体模板，有些只能用于函数，有些则只能用于变量或者成员，还有一些是通用的。 + +### 通用标签 + +- `@see 引用`：指定参考的文档。 +- `@since 版本`：指定从哪个版本开始引入的。 +- `@deprecated 版本`：指定从哪个版本开始废弃的。 +- `@version 版本`：指定版本号。 +- `@author 作者`：指定作者。 + +### 实体模板标签 + +- `@base 描述`：指定实体的基实体。 +- `@param 泛型参数名 描述`：指定泛型参数的描述。 + +### 函数标签 + +- `@return 描述`：指定返回值的描述。 +- `@throws 异常 描述`：指定抛出的异常的描述。 +- `@param 参数 描述`：指定参数的描述。 +- `@context 描述`：指定上下文的描述。一般是函数的执行环境。 \ No newline at end of file