代码不要冗余之道-注释

提问

应该写注释码

回答

• 注释不能美化糟糕的代码
• 注释会撒谎
• 代码应该自解释

提问2

那永远不写注释码？

回答

当对方看不到你的代码却要调用你的代码时注释不可获取例如
提供对外接口WebApi注释可以生成文档节省了单独编写文档的麻烦

• WebApi的接口说明
• 参数字段说明，示例
• 返回值字段说明，示例

Dont't

• 别注释代码
  //Console.log("写日志")
• 别在括号后写注释
• 别用注释标记位置