写代码不是自嗨,是团队协作
很多人刚入行时觉得,只要功能跑通就行,管它代码长什么样。可现实是,你写的代码不光自己要看,同事要读,几个月后的你自己还得维护。我见过太多项目因为命名混乱、结构随意,导致新成员接手像在破案——谁写的这玩意?现在在哪调用的?变量到底存了啥?
规范不是束缚,而是降低沟通成本。就像大家都遵守红灯停绿灯行,路上才不会乱套。代码也一样,统一风格让所有人用同一种语言交流。
命名清晰,少写十行注释
别再用 data、temp、list1 这种名字了。看到 userOrderList 和 filteredActiveProducts,谁都能猜出这是干啥的。你在咖啡机旁跟同事提需求时说“把用户订单列表过滤一下”,写代码就该这么命名,别整抽象艺术。
函数名也一样。handleClick 不如 submitRegistrationForm 明确。多敲几个字母省下的是后期反复翻代码的时间。
结构统一,一眼定位问题
一个文件里函数东一个西一个,状态定义在中间,工具方法塞在底部,找起来太费劲。我们组现在规定:先 import,再状态定义,接着生命周期或副作用,最后是渲染和辅助函数。新人第一天就能摸清套路。
组件拆分也得有章法。别把所有逻辑堆在页面组件里。把表单、弹窗、列表项抽成独立组件,改头像上传不牵动用户资料主模块。复用只是好处之一,关键是改一处不影响八处。
代码示例:从混乱到清晰
<!-- 混乱写法,三个月后自己都懵 -->
<script>
const d = [];
function f() {
fetch('/api/u')
.then(res => res.json())
.then(data => {
d = data;
render();
});
}
function render() {
// 渲染逻辑混在这里
}
</script><!-- 规范之后,职责分明 -->
<script>
import { fetchUserList } from '@/api/user';
import UserTable from './components/UserTable.vue';
export default {
components: { UserTable },
data() {
return {
userList: []
};
},
async mounted() {
this.userList = await fetchUserList();
}
};
</script>工具辅助,别靠人肉检查
靠人提醒太累,直接上 ESLint、Prettier。提交代码前自动格式化,不符合规范直接报错。一开始嫌烦,两周后就习惯成自然。我们还配了 Git Hook,不合规的代码推不上去,倒逼所有人统一风格。
团队用同一个配置,编辑器一打开就自动对齐缩进、修正引号。不用开会争论“用双引号还是单引号”,机器说了算。
规范越早定,后期越轻松
项目启动时花半天定好目录结构、命名规则、提交格式,比后期花十天重构强。新功能往哪放,文件怎么起名,都有据可循。不用每次开工先纠结结构。
我们之前接一个老项目,没有规范,改个按钮颜色得查五层嵌套。后来痛定思痛,重写前先立规矩,第二版开发速度直接翻倍。不是写得更快了,是花在理解旧代码上的时间少了大半。