← 返回刚才阅读的位置

知识卡片

普通读书笔记卡 · 1496.b

发布即应整洁

理解等级:未标注

JS 代码常以源码形式直接发布给浏览器、工具和开发者阅读,应自始至终具备发布质量,用清晰一致的风格编写。注释同样要求:保持与代码同步(错误注释比没有更难理解),不写”i=0; // 设置i为0”这类无信息量注释,理想是让程序结构自我说明。发散:不要把”能跑”当终点,长期维护成本往往从第一次随意提交开始积累。

这张卡片看不懂?

已有反馈 · 0 条

    还没有人提交反馈。

    在整书笔记中的位置

    原书出处 · 1 处

    参考来源

    - 位置:《JavaScript语言精粹(修订版)》第9章《代码风格 Style》 - 结论依据:原文指出"JavaScript代码经常被直接发布。它应该自始至终具备发布质量,要干净利落",并说明注释要保持最新、避免无用注释,理想是让程序结构自我说明,据此推出发布中的源码应始终保持整洁一致这一结论。 - 原始内容:JavaScript代码经常被直接发布。它应该自始至终具备发布质量,要干净利落。通过在一个清晰且始终如一的风格下编写,你的程序会变得易于阅读……我努力保持注释是最新的。错误的注释甚至可能会使程序更加难以阅读和理解。