Bom dia Trailblazers!!! 

Hoje vamos começar uma série de artigos referentes às boas práticas no mundo das clouds do Salesforce.

Porque das clouds e não da Sales cloud ou da Service cloud?

A maioria das clouds da Salesforce partem da mesma plataforma e com isso boa parte das funcionalidades podem ser utilizadas nelas.

Do que vamos falar hoje então, Como Comentar seu código.

Porque? Simples, um código deve ter comentários pois no mundo Salesforce não são apenas desenvolvedores que irão verificar o código. 

Administradores, Consultores, Analíticos de negócio, Arquitetos, Engenheiros de implementação entre outros poderão verificar seu código e eles não precisam entender de ponta-a-ponta o que seu códigos faz ou deveria fazer.

Muitas situações requerem outras pessoas esta verificação e utilizando o básico do básico das regras de comentários você estará facilitando a vida de todos.

Não precisamos escrever um livro comentado o código porém um cabeçalho bem criado e um comentário básico nos métodos já são um ótimo caminho.

Sabemos que existem desenvolvedores que comentam quase todas as linhas principais, vai de cada pessoa adotar um método que seja melhor ou dependendo das estrutura da empresa em que você trabalhe ou preste serviço para, seguir o padrão definido por eles quando existir é claro.

Lembrando também que já existem aplicativos que verificam os comentários dentro dos códigos e criam uma documentação de suporte.

Então aqui segue o exemplo que uso para estas duas situações.

* Comentário Inicial de Classe

Este tipo de comentário fica no topo inicial de uma classe apex ou trigger.

Ele propicia a visão inicial da classe e seu objetivo geral de utilização. Bem como a cada atualização ou modificação a informação básica de quem a fez e do porque.

/* ********************************************************* Apex Class Name    :     ControlsVerification Created Date            :     Oct 01, 2022 Description               :     This is class is used for.... Author                       :     Mauricio Silva Modification Log: Ver      Date                     Author                                        Modification 1.0      Nov-01-22          Claybom Chocolate                  Initial Version ********************************************************* */

* Comentário no nível do método

Este tipo de comentário serve para esclarecer a ação executada e resultado esperado.

/* ********************************************************* Method Name     : CreateCarFunction Author                  : Mauricio Silva Description          : provide an overview of the method Param                   : description about what the parameter does Return                   : description of the return value from the method ******************************************************** */

Bom pessoal, para iniciar nosso ciclo de Boas Práticas no mundo Salesforce de desenvolvimento.

No próximo falaremos de layouts e formatação do código.

Qualquer dúvida, sugestões, críticas e idéais, sinta livre para fazer aqui no nosso grupo. Até a próxima!!!

Gostaria de convidar você a fazer parte dos nossos alertas de reuniões virtuais e presenciais, acesse  o link do Trailblazer Grupo , de um JOIN lá. Assim você receberá os alertas das futuras reuniões e encontro que faremos mensalmente.