echocache/echocache-first-assistant icon
public
Published on 4/3/2025
My First Assistant

This is an example custom assistant that will help you complete the Python onboarding in VS Code. After trying it out, feel free to experiment with other blocks or create your own custom assistant.

Rules
Prompts
Models
Context
deepseek DeepSeek-V3 model icon

DeepSeek-V3

deepseek

deepseek DeepSeek-R1 model icon

DeepSeek-R1

deepseek

**一、代码规范**  
1. 命名:宏全大写(`MAX_LEN`),函数小写+下划线(`read_sensor`),类型小驼峰(`DataPacket`)  
2. 格式:4空格缩进,单行条件/循环也加{},指针符号`*`贴变量  
3. 长度:函数≤50行,嵌套≤3层  

**二、硬件规范**  
1. 寄存器:宏定义访问,位操作用掩码,改后加状态等待  
2. 中断:处理时间<中断周期20%,优先清标志,禁阻塞API  
3. 外设:结构体封装,跨平台用抽象层  

**三、资源规范**  
1. 内存:动态分配仅初始化,`sizeof`清内存,栈深标注  
2. 功耗:关闲置外设时钟,低功耗禁浮点,循环加休眠  

**四、安全规范**  
1. 数据:全局变量加`volatile`,缓冲区边界检查,关键参数`const`  
2. 执行:共享资源关中断保护,固件升级双备份,禁递归  

**五、维护规范**  
1. 注释:函数头写`@brief/@param/@retval`,硬件代码标芯片型号  
2. 架构:驱动/业务分离,平台代码集中放`port`目录  

**六、合规标准**  
1. 强制:MISRA C/CERT C/IEC 61508 SIL2  
2. 建议:圈复杂度<15,单元测试覆盖率≥90%  

**工具链**  
静态分析(Cppcheck+MISRA)  
自动格式化(Clang-format)  
功耗验证(EnergyTrace)  

No Docs configured

Prompts

Learn more
My prompt
A sample prompt
### **嵌入式C语言注释规范提示(AI助手版)**  

#### **📌 核心原则**  
1. **清晰性**:注释应当解释代码的设计意图和背后的逻辑,而非简单重复代码行为。  
2. **简洁性**:避免过度注释,仅对关键算法、特殊约束或非直观逻辑进行说明。  
3. **一致性**:全项目采用统一的注释风格,包括格式、术语和详细程度。  

---

### **📝 注释规则**  

#### **1. 文件头注释**  
- **位置**:每个源文件(`.c`/`.h`)开头  
- **必备字段**:  
  - 文件名  
  - 功能概述(1~2句话)  
  - 作者/维护者  
  - 创建/修改日期  
  - 版本号(可选)  
  - 硬件/依赖说明(如:`依赖STM32 HAL库,使用TIM3通道2`)  

#### **2. 函数注释**  
- **位置**:函数定义前  
- **必备字段**:  
  - 功能简介(`@brief`)  
  - 参数说明(`@param`,包括单位和取值范围)  
  - 返回值(`@retval`,列举所有可能状态码)  
  - 注意事项(`@note`,如:`此函数必须在中断禁用环境下调用`)  

#### **3. 代码块注释**  
- **逻辑注释**:对复杂算法、状态机或数学公式逐步骤说明  
- **安全注释**:标注临界区保护、并发风险、硬件时序要求  
- **调试注释**:临时添加的调试代码需明确标记(如:`TODO: 待优化CRC校验速度`)  

#### **4. 行尾注释**  
- **限制**:仅允许解释非直观的单行代码(如:`reg |= 0x80;  // 启用高速模式`)  
- **禁止**:重复代码语义(如:`i++;  // i加1`)  

---

### **⚠️ 禁止事项**  
1. 注释与代码实际行为不一致  
2. 遗留无意义的临时注释(如:`//test`)  
3. 使用非通用缩写(如:`// FIX HW BUG`应改为具体描述)  

---

### **🛠️ 工具辅助建议**  
- 使用Doxygen生成API文档  
- 通过静态分析工具(如SonarQube)检查注释覆盖率  
- 代码评审时验证关键注释的准确性  

(注:优先遵守项目现有规范,硬件相关代码必须标注芯片型号和寄存器地址来源)

Context

Learn more
@code
Reference specific functions or classes from throughout your project
@docs
Reference the contents from any documentation site
@diff
Reference all of the changes you've made to your current branch
@terminal
Reference the last command you ran in your IDE's terminal and its output
@problems
Get Problems from the current file
@folder
Uses the same retrieval mechanism as @Codebase, but only on a single folder
@codebase
Reference the most relevant snippets from your codebase

No Data configured

MCP Servers

Learn more

No MCP Servers configured