代码开发常用标记

在代码开发过程中，为了便于团队协作和自我管理，开发者常常会在代码中使用特定的标记（tags）或注释（comments），以提醒自己或他人需要注意的地方或待完成的任务。以下是一些常用的标记：

1. TODO：用途：标记需要完成的任务或需要添加的功能。示例：// TODO: 实现用户登录功能
2. FIXME：用途：标记已知的问题或需要修复的错误。示例：// FIXME: 这个地方在某些条件下会导致死锁
3. Note：用途：记录重要信息或注意事项，如为什么选择某种实现方式。示例：// NOTE: 由于性能考虑，这里使用了同步而非异步
4. HACK：用途：标记临时解决方案或权宜之计，通常意味着这不是最佳实践。示例：// HACK: 临时关闭这个特性，等待进一步测试
5. XXX：用途：标记可疑或不确定的地方，可能需要重新评估。示例：// XXX: 这样做真的好吗？
6. OPTIMIZE：用途：标记需要优化的部分。示例：// OPTIMIZE: 减少内存使用
7. REFACTOR：用途：标记需要重构的代码部分。示例：// REFACTOR: 重构这段代码以提高可读性
8. IDEA：用途：记录想法或潜在的改进方向。示例：// IDEA: 使用协程来处理并发请求
9. REVIEW：用途：标记需要审查的代码。示例：// REVIEW: 这个算法是否正确？
10. DEPRECATED：用途：标记已被废弃但仍存在的代码。示例：// DEPRECATED: 不再使用，请移除

示例：

package main

import (
	"fmt"
	"sync"
)

// TODO: 实现用户登录功能
func login(username, password string) bool {
    // 这里应该实现登录逻辑
    return false
}

// FIXME: 这个地方在某些条件下会导致死锁
func doSomethingImportant() {
    mutex.Lock()
    defer mutex.Unlock()
    // 有可能在这个地方发生死锁
    doOtherThing()
}

// NOTE: 由于性能考虑，这里使用了同步而非异步
func syncOperation() error {
    // 同步执行操作
    return nil
}

// HACK: 临时关闭这个特性，等待进一步测试
func disableFeature() {
    enabled := false
    // 这里关闭了特性
}

// XXX: 这样做真的好吗？
func questionableOperation() {
    // 这里做一些不确定是否正确的操作
}

// OPTIMIZE: 减少内存使用
func optimizeMemoryUsage() {
    // 这里应该优化内存使用
}

// REFACTOR: 重构这段代码以提高可读性
func complexFunction() {
    // 这段代码比较复杂，需要重构
}

// IDEA: 使用协程来处理并发请求
func handleRequests(requests []http.Request) {
    // 这里可以考虑使用协程
}

// REVIEW: 这个算法是否正确？
func algorithmCheck() {
    // 这里实现了某个算法
}

// DEPRECATED: 不再使用，请移除
func oldFunction() {
    // 这个函数已经不再使用
}

func main() {
    fmt.Println("Welcome to the Go code with annotations!")
    var mutex sync.Mutex
}

在IDE中这种特殊标记会高亮显示：

导航定位到TODO，在终端会显示相应所有标记