学会给项目里的东西起清楚的名字

学会给项目里的东西起清楚的名字

写代码时,起名字经常被当成最后才处理的小事。但当文件越来越多,我发现清楚的名字本身就是一种沟通。

一个叫 index2.astro 的文件几天后就会让人困惑;一个叫 PostCard.astro 的组件,则能马上说明它的用途。变量也是一样,postsdata 更容易理解,publishedPosts 又比 posts 多了一层明确的含义。

现在我给自己一个简单标准:名字要能回答“它是什么”和“它用来做什么”。如果需要写很长的注释才能解释名字,大概率应该重新命名。

这不是追求完美,而是给未来的自己留下一条更容易走回来的路。