Apex开发指南--注释的重要性

最新推荐文章于 2023-10-14 21:39:47 发布

码山搬运工

最新推荐文章于 2023-10-14 21:39:47 发布

阅读量742

点赞数

分类专栏： Salesforce搬砖文章标签：注释 apex salesforce

本文链接：https://blog.youkuaiyun.com/weixin_41126799/article/details/98882844

版权

本文探讨了Apex开发中注释的重要性，包括方便自我排查问题、协助同事理解代码、保障代码质量和促进职业发展。同时，文章介绍了编写注释的三个阶段：开头、中间和结尾，强调了良好的注释习惯对于提升代码可读性和维护性不可或缺的角色。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

学习目的：
1，为什么要注释
2，怎么做注释

为什么要注释

刚开始入行的时候，觉得代码自己看得懂就可以。写注释干嘛？浪费时间。后面又一次我的代码被大佬review，一顿恶骂后，我还是没有觉得这个重要性。直到有一天我背安排对一个功能进行二次开发的时候，我记得我从早上打开电脑能够嘴巴开始碎碎念到下班的时候，才明白：注释真的很重要。
1，方便自己排查问题
2，方便后面的同事填坑
3，为了人身安全
4，为了涨薪

怎么做注释

开头：

/**************************************************************************************************
 * Name: CPQ_DiscountVocherCtl
 * Object: 
 * Purpose: Controller for Aura CPQ_DiscountVoucher
 * Author: Christ Lai(xiong.lai@xxxx.com)
 * Create Date: 2019-08-07
 * Modify History:
 * 2019-08-07    xiong lai    Create this class
 **************************************************************************************************/

中间：

1，内部类的变量要给字段后面写上中文备注，这个字段啥意思（大部分命名很难做到见名知意）

最低0.47元/天解锁文章