到底要不要写注释

合集 - 157(5)
1.属性字段为什么要在构造函数中初始化2.静态初始化器知多少3.因为1s少了1d
4.到底要不要写注释
5.条件编译怎么用
收起

提问

到底要不要写注释

回答

内部代码尽量少写注释
原因
1.再完美的注释也无法解释糟糕的代码
2.注释不会随着重构变更

公开API代码高尽量写完善注释
原因
可以利用注释生成API文档

posted @   东百牧码人  阅读(5)  评论(0)  编辑  收藏  举报
相关博文：
· 代码不要冗余之道-注释
· <inheritdoc>啥意思
· 你觉得该不该写注释？你写注释的原则是什么？
· 你觉得该不该写注释？你写注释的原则是什么？
· 02-注释
阅读排行：
· 无需6万激活码！GitHub神秘组织3小时极速复刻Manus，手把手教你使用OpenManus搭建本
· Manus爆火，是硬核还是营销？
· 终于写完轮子一部分：tcp代理 了，记录一下
· 别再用vector＜bool＞了！Google高级工程师：这可能是STL最大的设计失误
· 单元测试从入门到精通
历史上的今天：
2022-05-18 Dispose 配合Finalize 释放对象
2022-05-18 使用swagger.json 自动生成调用WebAPI代码[二]
2022-05-18 C# WebSocket客户端[二]
2022-05-18 C# WebSocket客户端[一]
点击右上角即可分享
微信分享提示