Unity开发者联盟's Archiver
论坛
›
代码库 Code
› 在unity中用C#写脚本,注释要写到什么程度最合适?(请举例)
RecursiveFrog
发表于 2021-9-27 09:22
我觉得首先代码应该有统一的思路和规范,可以靠框架来约束,把不可读代码集中到小范围内,大体层面不需要注释,比如基于状态机,或者基于事件,或者有比较标准的设计模式实现。
在小范围内首先通过清晰的类定义和变量名,方法名来保证代码基本可读。尽量拆分方法。
在所写的类的前面也可以写一些类的设计思路之类的注释
到具体的实现细节,有些地方可能技巧性很强,就需要写注释了。如果是来源网络,可以把算法的链接附上,或者写出算法名。比较特殊的变量也要把用途表达清楚。
页:
1
[2]
查看完整版本:
在unity中用C#写脚本,注释要写到什么程度最合适?(请举例)