6.4. 代码注释和解析 | 写作技巧 |《社区文档撰写指南》| learnku 产品论坛-金年会app官方网
简介
技术文章里，避免不了的，会带有大量的注释，本篇文章讨论代码注释和代码讲解时需要注意的地方。
1. 避免无用的注释
很多时候是代码生成器生成的，如下：
boolean('email_verified')->default(false)->after('remember_token');
});
}
/**
* reverse the migrations.
*
* @return void
*/
public function down()
{
schema::table('users', function (blueprint $table) {
$table->dropcolumn('email_verified');
});
}
}此时应删除掉注释，原因如下：
删除以后，干净也专注很多了：
boolean('email_verified')->default(false)->after('remember_token');
});
}
public function down()
{
schema::table('users', function (blueprint $table) {
$table->dropcolumn('email_verified');
});
}
}
2. 善用注释来讲解大块代码
大块代码在文章中讲解，经常会遇到以下的问题：
一个合理的做法是，直接在代码里添加注释，这样可读性要好多了：
