文章详情

短信预约-IT技能 免费直播动态提醒

请输入下面的图形验证码

提交验证

短信预约提醒成功

编写高质量可维护的代码:一目了然的注释

2024-12-10 16:33

关注

编程语言中对“注释”的解释

注释就是对代码的解释和说明。注释是开发人员在编写程序时,给一段代码的解释或提示,有助于提高程序代码的可读性。注释不会被计算机编译。

[[344072]]

要不要加注释?为什么要加注释?

注释的存在就是为了方便自己的二次阅读和代码维护以及项目交接。可以更好的理解代码,有助于提高协作效率,加快开发进程。

试想,你添加了一段逻辑较为复杂的代码,几个月后再看,还能不能迅速看懂?你刚刚接手一个老项目,项目里基本没有注释且逻辑复杂,你能高效率的看懂代码和了解业务吗?

所以添加注释还是有一定必要滴。

基础篇

快捷键 windows 系统: Ctrl+/ ios 系统: Command+/

注释的分类

<div>
  这是一行文字
  
div>
  1.  
  1. div { 
  2.      
  1. div { 
  2.        
  3.     // font-size: 14px; // 单行注释 
  4.     background: #000
  1. * 用注释来阻止代码执行  —— 被注释的 JS 代码将不被执行 
  2.  
  3. ```js 
  4. //alert("123")  // 执行时未弹出该信息 
  5. alert("456")  // 执行时弹出该信息 
  6. ``` 
  1.  
  2. const onSubmit = (params = {}) => { 
  3.   const result = false
  4.     if (params) { 
  5.             result = true
  6.         } 
  7.     return result; 
  8. }; 
  1. // TODO功能未完成,待完善 
  2. // FIXME  待修复 
  3. // XXX    实现方法待确认 
  4. // NOTE   代码功能说明 
  5. // HACK   此处写法有待优化 
  6. // BUG    此处有Bug 
  7. const arr = [] 

Tips:

注释写法规范

  1.  
  1. // 这是一行注释 
  1.  
来源:ZooTeam Blog内容投诉

免责声明:

① 本站未注明“稿件来源”的信息均来自网络整理。其文字、图片和音视频稿件的所属权归原作者所有。本站收集整理出于非商业性的教育和科研之目的,并不意味着本站赞同其观点或证实其内容的真实性。仅作为临时的测试数据,供内部测试之用。本站并未授权任何人以任何方式主动获取本站任何信息。

② 本站未注明“稿件来源”的临时测试数据将在测试完成后最终做删除处理。有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

软考中级精品资料免费领

  • 历年真题答案解析
  • 备考技巧名师总结
  • 高频考点精准押题
  • 2024年上半年信息系统项目管理师第二批次真题及答案解析(完整版)

    难度     813人已做
    查看
  • 【考后总结】2024年5月26日信息系统项目管理师第2批次考情分析

    难度     354人已做
    查看
  • 【考后总结】2024年5月25日信息系统项目管理师第1批次考情分析

    难度     318人已做
    查看
  • 2024年上半年软考高项第一、二批次真题考点汇总(完整版)

    难度     435人已做
    查看
  • 2024年上半年系统架构设计师考试综合知识真题

    难度     224人已做
    查看

相关文章

发现更多好内容

猜你喜欢

AI推送时光机
位置:首页-资讯-后端开发
咦!没有更多了?去看看其它编程学习网 内容吧
首页课程
资料下载
问答资讯