Programas Documentados
Programação pode ser uma grande aventura se não tomarmos certos cuidados, um programa pode se tornar bastante confuso de entender. Nesta lição falaremos sobre comentários, sua importância e a maneira correta de inseri-los em seus scripts.Por que é importante documentar seus programas?
Quando codificamos, estamos escrevendo programas usamos uma linguagem estritamente técnica as vezes subjetivas, que com o passar do tempo podem perder seu significado interpretativo, e pode não refletir claramente o que você estava pensando quando criou o script.Ora, isso pode criar dificuldades para terceiros (ou mesmo para você) quando se tratar de entender como o script foi estruturado e como consequência tornar extremamente árdua a tarefa de identificação e correção de erros.
Isso não quer dizer que você como um bom programador deva deixar todo seu árduo trabalho totalmente aberto e com entendimento facilitado de fálcil entendimento a qualquer um, Isso é claro e desejável nas empresas, mas não quando falamos de seus próprios projetos.
Comentários são usados para se escrever pequenos textos explanatórios no script. O servidor ignora qualquer comentário no script e eles não afetam ou interferem com a funcionalidade do script.
No mundo dos negócios é comum as Companhias exigirem que os scripts e programas sejam comentados, pois é considerado um alto risco aceitar um sistema no qual a identificação e correção de erros se torna uma tarefa difícil pela falta de comentários.
também e muito possível criarmos um index com arquivos explicativos, assim se você deseja uma segurança maior esse e o caminho, empresas nem sempre preferem programas comentados, principalmente se você esta fazendo um programa WEB de acesso a contas restritas, esse tipo de código e muito facilmente acessado, tenho visto muitos códigos de grandes empresa como Oracle Microsoft etc. que parecem verdadeiros ninhos de ratos, com muitos links externos códigos emaranhados quase impossível de ser decifrado ou muito trabalhoso, assim fica a merce dos ventos
o tipo e codificação e documentação...
Como inserir comentários?
É fácil inserir um comentário. Você simplesmente começa um texto de comentário escrevendo duas barras: "//".Observe um exemplo mostrado na lição 5 no qual inserimos comentários:
<html> <head> <title>Loops</title> </head> <body> <?php // Escreve código de cores usando três loops // Vermelho pode estar entre 0 e 255 for ($intRed=0; $intRed<=255; $intRed=$intRed+30) { // Verde pode estar entre 0 e 255 for ($intGreen=0; $ intGreen<=255; $intGreen=$intGreen+30) { // Azul pode estar entre 0 e 255 for ($ intBlue=0; $intBlue<=255; $intBlue=$intBlue+30) { // O código de cores tem o formato rgb(vermelho,verde,azul) $strColor = "rgb(" . $intRed . "," . $intGreen . "," . $intBlue . ")" // Aqui escrevemos o código da cor echo "<span style='color:" . $strColor . "'> " . $strColor . " </span>"; // Fecha os loops } } } ?>
Nenhum comentário:
Postar um comentário