examples/vue-ts-example
1
0
Fork 0
Code Issues Pull Requests 5 Actions Packages Projects Releases Wiki Activity

fix: 更新代码注释规范，强调注释应解释复杂逻辑和设计意图，而非重复代码或描述位置

Browse Source
This commit is contained in:
严浩
2025-04-01 16:15:39 +08:00
parent f32c52867f
commit c829eaaf71
1 changed files with 7 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
.github/copilot-instructions.md vendored
View File

@ -11,7 +11,10 @@ This document outlines the core technical choices, coding conventions, and confi
1. `<script setup lang="ts">` (Imports, logic, composables, etc.)
2. `<template>` (HTML structure)
3. `<style>` (Preferably `<style scoped>`)
* **Code Comments:** All comments within the codebase **must be written in Chinese**. (代码中的所有注释**必须使用中文**。) **注释应解释代码的“为什么”或复杂逻辑，而不是解释“是什么”或重复代码/配置本身。**
* **Code Comments:**
* All comments within the codebase **must be written in Chinese**. (代码中的所有注释**必须使用中文**。)
* **注释应解释代码的“为什么”（设计意图、选择某方案的原因）或复杂逻辑/算法的“如何”，而不是解释“是什么”（重复代码功能）或“在哪里”（描述定义位置）。**
* **严禁添加仅说明代码被移动、重构或提取到其他文件的注释。** 例如，避免 `// XxxState 接口已移至 types.ts` 或 `// 提取为 useXYZ composable` 这样的注释。依赖代码结构、类型系统和 IDE 功能（如 Go To Definition）来理解这些信息，而不是通过注释。Focus comments on the *logic* itself, not its location or history.
## 📦 UI Libraries & Components
@ -21,7 +24,7 @@ This document outlines the core technical choices, coding conventions, and confi
* **PrimeVue:** Use components directly with their standard names (e.g., `<Button>`, `<InputText>`, `<DataTable>`).
* **Custom Components:** Local components (e.g., `<MyCustomComponent />` defined in `src/components/MyCustomComponent.vue`) should be used directly in templates without explicit imports in `<script setup>`.
* **Custom Icons:** Custom SVG icons are available via `unplugin-icons` with the prefix `icon-`. Usage: `<icon-your-svg-file-name />`.
* **No Auto-Import Comments for Components:** When using auto-imported components (UI libraries, local components), **do not** add comments indicating they are auto-imported. Assume this behavior is known.
* **No Auto-Import Comments for Components:** When using auto-imported components (UI libraries, local components), **do not** add comments indicating they are auto-imported. Assume this behavior is known. Trust the tooling.
## ✨ API Auto-Import (unplugin-auto-import)
@ -41,13 +44,9 @@ This document outlines the core technical choices, coding conventions, and confi
* **Always** use `<script setup lang="ts">`.
* Composition API is the **only** accepted style.
* Code comments **must be in Chinese** and explain **why/how**, not what or the build system.
* Code comments **must be in Chinese** and explain **why/how (logic, intent)**, **strictly avoiding** comments that explain **what (code repetition), where (definition location), refactoring history, or auto-import mechanisms.**
* Vue 3 Composition API, Pinia, Vue Router (auto), VueUse functions, `consola`, and exports from `src/stores` & `src/utils` are globally available via auto-import; **do not** import them explicitly.
* Ant Design Vue, PrimeVue, and local `src/components` components are auto-imported; use them directly in templates without explicit imports.
* **Crucially: Do not add comments solely to explain that an API or component is auto-imported.** Trust the auto-import setup.
* **Crucially: Do not add comments solely to explain that an API or component is auto-imported OR where code has been moved/refactored.** Trust the auto-import setup and IDE navigation.
* Use custom SVG icons via the `<icon-name />` syntax.
* Maintain the specified SFC structure: `<script setup>`, `<template>`, `<style>`.
---
*(Further details regarding state management patterns, routing configuration, specific linting rules, testing setup, or detailed coding style guides can be added to this document as needed.)*