命名规范化的重要

    命名的规范有助于逻辑的清晰描述,好的命名,他人维护的时候,通过命名就可以了解功能的大概。

    有位大牛说:写代码应该第一是为了让别人看的,其次才是让程序顺便跑起来。

关于命名规则总结了两条:

1、当有实际场景时,用更能表达场景的词命名。

   例如:表示状态的词常用,state,status,这样的字段在状态机中也是有的。

但是在表示明确的比如价格状态,是否有库存状态,最好用price_status,inventory_status这样看起来非常直观且语言明确。

2、当定义通用方法时,用语言宽广的词命名。

   例如:有一个最近7天报表功能,定义一个查报表数据的时候,可以用daily_report这样的命名,但是考虑到这个查报表数据的方法可能在其他地方也会调用到这个数据查询,但并不一定是个报表需求。所以对于这样的方法命名为recent_orders

猜你喜欢

转载自schooltop.iteye.com/blog/2314707