メニュー
Write and unify JSDoc, inline comments, and file headers following the project's established style. Use when adding or editing code comments.
デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。
インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。
Codex または Claude でインストール この Prompt をコピーして Codex、Claude、または他のアシスタントに貼り付けると、Skill ページを確認してインストールできます。
直接コマンドでは確認用 Prompt が省略されます。実行前にソースを確認してください。
npx skills add https://github.com/HoundTek/hound-whiteboard --skill comment-writerコマンドは1行のまま表示されます。コピー前に横へスクロールして全体を確認してください。
ローカルで確認しますか？SkillsMP が現在取得できるファイルをダウンロードできます。
SKILL.md を表示中
| name | comment-writer |
| description | Write and unify JSDoc, inline comments, and file headers following the project's established style. Use when adding or editing code comments. |
按项目既有风格为代码补写、改写、统一 JSDoc 和行内注释。
写作前先读取目标附近最邻近的现有注释：
归纳稳定写法后再落笔。
所有源码文件头部统一为：
/**
* @file ...
* @description ...
* @module kernel/...
* @author ...
*/
@file — 简短的文件名或职责描述@description — 一句话说明文件职责，必须打句号@module — 路径格式为 {kernel|canvas|host|ui|io|cli}/{path/to/module}，与源码路径对应（各包根目录即前缀）@author — 作者名。不确定时执行 git config user.name测试文件（.test.js）不应写 @module。原因：
@module 对文档生成和模块图无贡献foo.test.js 就在 tests/ 里紧挨 foo.js），路径关系一目了然@module 路径和 .test.js 后缀的命名冲突增加了维护噪音文件头只需要 @file、@description（可选）和 @author，例如：
/**
* @file 区块加载器测试
* @author Zhou Chenyu
*/
check-module-paths.mjs 会自动跳过 .test.js 文件。
作者名可执行 git config user.name、git config --global user.name 获取。
单行示例：
/**
* @file 白板组件
* @description Board 类是白板在面向对象设计中的抽象核心。
* @module ui/components/orchestration/board
* @author ...
*/
多行示例：
/**
* @file BoardApi 同线程实现
* @description
* 提供 BoardApi 接口的同线程实现，直接调用 BoardCore 的同步/异步方法。
* P2 阶段保持同步封装，P3 切为 RPC 实现后保持相同方法签名。
* @module kernel/api/board-api
* @author Zhou Chenyu
*/
注意多行时 @description 之后不可跟文字，正文从下一行开始。
所有新增或修改的下列实体都要写 JSDoc：
@description 必须打句号@description 只有一行时，正文跟在标签后面；如果正文有多行（含一段以上的描述），标签必须单独一行，正文从下一行开始，不可在 @description 后直接跟文字@description 之外的标签（@param、@returns、@throws、@type、@todo 等），一句话时不打句号，多句话时要打句号/** 之后），一律不打句号。需多句描述时，改用 @description 标签承载详细内容。禁止单行 /** @type {xxx} */ 格式。字段和属性的 JSDoc 必须使用多行格式，第一行写描述（不打句号），@type 单独一行：
/**
* 当前修改手势是否激活
* @type {boolean}
*/
isModifyingGestureActive = false;
/**
* 手势锚点（世界坐标）
* @type {{ x: number, y: number } | null}
*/
_anchorPosition = null;
@type 之前的描述行不可省略——即使变量名已能表达含义，仍需写中文描述。
方法注释优先写：
@param 的含义@returns 的含义@throws 的条件不要重复实现细节。
示例：
/**
* 将当前修改对象提交回静态图
* @param {Object} modificationContext - 修改上下文
* @param {Iterable<*>|*} [objects] - 显式传入的对象或对象集合
* @returns {boolean} 是否成功提交
*/
applyModifiedObjects(modificationContext, objects) { ... }
/**
* 通用对象修改工具类
* @class
* @extends GestureBasedObjectModifierTool
* @description 手势驱动的对象位置修改工具，适用于所有对象类型。
*/
class CommonObjectModifierTool extends GestureBasedObjectModifierTool {
/**
* @param {{
* onViewportChange?: Function,
* onFlush?: Function,
* }} [options={}] - 配置选项
*/
constructor(options = {}) { ... }
/**
* 对象创建工具相关信号类型常量
* @readonly
* @enum {string}
*/
const OBJECT_CREATOR_SIGNAL_TYPES = Object.freeze({
POSITION: "position",
GESTURE_END: "end",
...
});
事件通过 Tool.on(name, callback) / Tool._emit(name, ...) 机制发布。事件 JSDoc 格式：
/**
* 对象创建生命周期完成通知。
* handoff 通过 {@link Tool#on|on('afterCreate', ...)} 订阅。
* @param {Object} interaction - 当前交互上下文
* @param {BasicObject} completedObject - 已完成的对象
* @protected
*/
afterCompleteCreatedObject(interaction, completedObject) {
this._emit("afterCreate", interaction, completedObject);
}
@private — 以下划线 _ 开头的方法或属性@protected — 子类可访问的方法@public@abstract — 抽象方法或类@deprecated — 已废弃的 API，需说明替代方案@todo — 待完善事项// ---- / // ===== / // ****// -- xxx ---- / // == xxx === / // ** xxx **
SOC 職業分類に基づく