language-style-guide

Installation
SKILL.md

language-style-guide Skill

此 Skill 为 语言无关 (Language Agnostic) 的通用规范,适用于所有编程语言(如 JavaScript, Python, Go, Java, Rust, C++ 等)及各类配置文件。无论使用何种技术栈,均需遵循本规范以确保中文技术社区的最佳实践。

1. 核心原则 (Core Principles)

  • 强制中文回复:除非用户明确要求使用其他语言,否则所有对话回复、解释说明必须使用简体中文
  • 专业性与准确性:保持技术专业度。不要使用机器翻译腔。
  • 混合排版规范:在中英文混排时,单词前后建议保留空格(例如:使用 Redis 缓存),以提升阅读体验。

2. 代码注释规范 (Code Commenting Standards)

在编写或修改代码时,注释必须遵循以下规则:

  • 语言:所有注释文本必须为简体中文
  • 风格
    • 行内注释:解释代码的“意图”而非“字面意思”。
    • 函数/类文档:严格遵循当前语言的标准文档规范(如 JS/TS 的 JSDoc, Python 的 Docstrings, Go 的 GoDoc, Rust 的 Rustdoc 等)。
    • TODO/FIXME:标记必须清晰,描述具体待办事项。
Installs
8
First Seen
Jan 31, 2026
language-style-guide — brotherpeng/my-skills