瞎扯淡 怎样写好注释

SunA0 · 2025年03月24日 · 最后由 zhengpd 回复于 2025年03月26日 · 228 次阅读

翻到两年前的代码

# 构建还款记录
# 其中还款减免不处理
 def xxxx
... ... 

第一反应是愣住了 为啥不处理啊 我当时特别注释不处理为啥呢 再过两年只有神能看懂了

你的注释少了一行:

# 构建还款记录
# 其中还款减免不处理
# 因为....
def xxxx
end

加个 TODO

按我的经验,有帮助的注释大体上有几种:

  • How: 使用文档、调用说明这类的信息,说明注释的对象能做什么,怎么调用,有什么结果
  • Why: 比如为什么这么命名、为什么不处理边界情况、什么需求导致使用了这个技术方案,重点突出一个“为什么”
  • Todo: TODO/FIXME 这类留给未来做的任务,提醒读者注释的对象存在未完成的部分
需要 登录 后方可回复, 如果你还没有账号请 注册新账号