【读书笔记】编码用这 16 个命名规则能让你少写一半以上的注释!
保持命名形式的一致性
避免缩写
将描述事物最准确的名词放在最后
让代码像语句一样连贯
对于非布尔类型的属性或变量使用名词
对于代表可执行某类操作布尔属性,优先使用能动词
对于布尔类型的参数,不要使用动词
对于布尔型属性和变量,应该使用正向名称
使用祈使动词来命名函数或那些产生其他效果的方法
对于主要目的是返回一个值的函数优先使用名词或非祈使动词
不要在方法名称开头加 get
如果方法是将一个对象复制成为另一种表现形式,那么使用 toX() 形式
如果返回的是原对象的不同的表现形式,那么使用 asX() 形式
不要在方法名称上重复参数名
对于泛型,遵循通用的助记符
避免缩写
将描述事物最准确的名词放在最后
让代码像语句一样连贯
对于非布尔类型的属性或变量使用名词
对于代表可执行某类操作布尔属性,优先使用能动词
对于布尔类型的参数,不要使用动词
对于布尔型属性和变量,应该使用正向名称
使用祈使动词来命名函数或那些产生其他效果的方法
对于主要目的是返回一个值的函数优先使用名词或非祈使动词
不要在方法名称开头加 get
如果方法是将一个对象复制成为另一种表现形式,那么使用 toX() 形式
如果返回的是原对象的不同的表现形式,那么使用 asX() 形式
不要在方法名称上重复参数名
对于泛型,遵循通用的助记符
Comments
Post a Comment