# remark

**Repository Path**: aforfar/remark

## Basic Information

- **Project Name**: remark
- **Description**: 这个工具可以帮助你在 Windows 系统中为文件夹添加备注信息，这些备注会显示在文件资源管理器的"备注"列中。

- **Primary Language**: Go
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-01
- **Last Updated**: 2026-10-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Windows 目录备注工具

这个工具可以帮助你在 Windows 系统中为文件夹添加备注信息，这些备注会显示在文件资源管理器的"备注"列中。
## 功能特点

- 为 Windows 文件夹添加自定义备注
- **支持注册到文件夹右键菜单，点击即弹出输入窗口，自动带入文件夹路径**
- 支持命令行参数和交互式两种使用方式
- 自动处理文件编码（支持 ASCII 和 UTF-16 LE with BOM）
- 自动设置文件属性保护 desktop.ini 文件
- 支持中文及其他非 ASCII 字符的备注内容

## 使用方法

### 方法一：右键菜单模式（推荐）

先注册一次右键菜单（写入当前用户注册表，**无需管理员权限**）：

````
remark.exe install
````

之后在资源管理器里**右键任意文件夹**，菜单中会出现 **"添加文件夹备注"**，点击后弹出控制台窗口：

- 窗口已自动带入所选文件夹的完整路径
- 只需输入备注文字并回车，备注立即生效
- 输入完毕后按提示回车关闭窗口，再按 F5 刷新资源管理器即可看到备注

卸载右键菜单：

````
remark.exe uninstall
````

> 说明：菜单注册位置为 `HKCU\Software\Classes\Directory\shell\AddFolderRemark`，
> 仅对文件夹生效。注册/卸载后程序会自动调用 `SHChangeNotify` 刷新资源管理器缓存。

### 方法二：命令行参数模式

````
remark.exe "C:\path\to\folder" "你的备注内容"
````
### 方法三：交互式模式

````
remark.exe 
````
运行后按提示输入文件夹路径和备注内容。

## 工作原理

1. 在指定文件夹中创建或修改 [desktop.ini] 文件
2. 添加 `[.ShellClassInfo]` 配置节和 `InfoTip` 属性
3. **给目标文件夹本身加上"系统(+s)"属性**——这是关键，Windows 只有在文件夹带系统属性时才会读取其 desktop.ini。若之前已设置过备注却看不到，多半是缺少这一步，可用 `attrib +s "文件夹路径"` 补上
4. 根据内容是否包含非 ASCII 字符自动选择编码方式：
   - 纯 ASCII 内容使用普通文本编码
   - 包含非 ASCII 字符的内容使用 UTF-16 LE with BOM 编码
4. 设置 desktop.ini 文件的系统和隐藏属性以防止意外修改

## 注意事项

- 仅适用于 Windows 系统
- 需要对目标文件夹有写入权限
- 添加备注后可能需要按 F5 刷新文件资源管理器才能看到效果
- `InfoTip` 显示为鼠标悬停在文件夹上的提示框；若要在"备注"列显示，需确保文件夹已加系统属性且该列已开启
- 备注长度建议不超过 255 个字符