25.04.2017
Olá!
Continuamos a aprender o básico do PHP do zero!
Nesta lição, direi o que é um comentário em PHP e, na prática, tentaremos escrever seu próprio comentário no código. Mas isso não é tudo. Eu também quero dizer a você como comentar o código e por que isso deve ser feito.
O que é um comentário emPHP
Comente emPHPé uma dica do desenvolvedor php para orientação rápida no código, bem como para edição.
Um comentário em PHP não é visível para o usuário que abriu a página da Web para visualização. Mesmo que o usuário decida olhar o código-fonte da página, o comentário ainda não estará visível, pois todos os arquivos php.
Comentário de código PHP
Existem 2 tipos de comentários para código PHP:
→ linha única
→ várias linhas
⇒ Comentário de linha única para PHP
Para um comentário de linha única, use os caracteres "//" ou "#"
Após esses caracteres, tudo o que estiver escrito em uma linha será ignorado e tratado como comentário.
Subscribe to update"; # subscribe (este é um comentário) ?>
Assine para atualizar
⇒ Comentário multilinha para PHP
Um comentário de várias linhas para PHP começa com "/*" e termina com "*/".
Qualquer coisa entre esses caracteres será ignorada e tratada como um comentário.
Um comentário de várias linhas é usado se houver várias linhas na entrada.
Na tela, você verá apenas o seguinte texto:
Olá leitores do blog - site !!!
P.S.: Sempre comente seu código. Se você acha que vai se lembrar de tudo o que fez no código em 1-2 anos, está enganado, a chance é muito pequena. Mesmo que você se lembre, terá que passar muito tempo estudando - o que, onde e por que ...
Torne o futuro agradável para você - comente o código e então você dirá para si mesmo "OBRIGADO!!!".
Deixe um comentário no código, levará 1 minuto do seu tempo, mas economizará um dia inteiro no futuro.
Comente o código PHP
Digamos que você escreveu um código php, mas por algum motivo você precisa remover 2 linhas do código.
Não estou com pressa de remover algo do código, especialmente se for código php, é melhor comentar. E de repente será necessário retornar o código. É mais fácil descomentar do que escrever código de uma nova maneira.
Como comentar o código emPHP
Um exemplo com um comentário de linha única:
!!!";
// echo "
Assine para atualizar"; ?>
Um exemplo com um comentário de várias linhas.
Do autor: comentar é um desses recursos que é fácil de implementar. Ao mesmo tempo, esses elementos de edição podem ser de grande benefício para os desenvolvedores que passam o código de mão em mão. Hoje você aprenderá como comentar um bloco no PhpStorm. Também consideraremos o restante da funcionalidade do ambiente de desenvolvimento para comentar o conteúdo do programa.
Comentários: bom e ruim
A capacidade de comentar o código está disponível na maioria das linguagens de programação (provavelmente todas, mas com graus variados de disponibilidade). Normalmente, esclarecimentos verbais são usados para ajudar outros membros da equipe com desenvolvimento adicional, ou simplesmente para se lembrar de que essa área precisa de correções (“FIX ME”).
Claro, uma explicação do que foi escrito é uma bênção. Mas com a ajuda de comentários, você pode riscar todos os lados bons do código. Para evitar que isso aconteça, é necessário distinguir entre os tipos de comentários:
documentar. Uma boa associação seria o conceito de documentação para vários softwares. Tais comentários ajudam no uso do código, como uma instrução. Tal comentário não é percebido como supérfluo, pois sem ele não há como. Imagine que alguém tenha usado o framework do autor e não lhe diga como usar o programa;
JavaScript. Início rápido
explicativo. Um bom código geralmente não precisa deles. Quanto mais linhas de comentários você vê em um programa, mais provável é que o programa seja mal escrito. Claro que isso não é uma regra absoluta.
Comentários explicativos podem ser úteis para aqueles que irão corrigir o código no futuro. Por exemplo, muitos jovens profissionais veem espaço para melhorias em todos os lugares. Eles acreditam que tudo era pior antes deles, e agora é hora de corrigir todos os recursos.
Às vezes, um sentimento semelhante supera os profissionais. Por exemplo, quando tudo parece surpreendentemente torto - deve haver uma solução melhor. Para evitar que os seguidores procurem algo melhor, um programador pode deixar uma nota como esta: #time_spent_here=24h
Depois de tais palavras, poucas pessoas querem gastar tanto tempo. Assim, você avisa que muitas opções diferentes já foram resolvidas. Ao mesmo tempo, você deve evitar esses ataques: #i_hate_this, #try_to_do_better_ass%%le. Desta forma, você está mostrando apenas uma atitude não profissional. Não comprometa a si mesmo e ao empregador.
Mas documentar comentários de código também pode se tornar lastro para um programador. Como regra, essas são seções enormes que distraem diretamente da programação. Mas para exibir o código sem comentários, existe uma função correspondente nos IDEs principais. Não deve ser uma exceção e PhpStorm, mas infelizmente. Procure o recurso nos documentos de atualização.
Tag como um elemento de funcionalidade
Embora os comentários tenham a intenção de esclarecer e ajudar no desenvolvimento da equipe, esses recursos não são usados com tanta frequência. Como regra, as tags são colocadas onde desejam interromper a execução do código. Digamos que você tenha PHP embutido em HTML. E você não quer apagá-lo, você só quer ver como a página fica sem ele. Para fazer isso, você deve seguir a seguinte sintaxe:
JavaScript
…
…< div > . . . < / div > < ? -- закомментированныйкоднаphp -- > < div > . . . < / div > |
Como você pode ver, com ações simples, você pode interromper a execução do código sem realizar nenhuma operação complexa. Mas, na verdade, este ainda não é o ápice da otimização. A conveniência adicional para o desenvolvedor é fornecida pelo próprio phpStorm IDE. Usando realce e atalhos de teclado, você pode comentar o segmento de código selecionado sem atribuir tags especializadas. Pode ser feito assim.
Usando um método conveniente para você, selecione um pedaço de texto (mouse, atalhos).
Pressione o atalho de teclado Ctr + Shift + /
Além disso, você pode comentar na linha atual. Ao mesmo tempo, só que sem Shift.
A vantagem desse tipo de comentário é a cobertura simultânea de vários idiomas. PHP é raro por si só. Dessa forma, você não precisa recorrer à marcação de cada um. O ambiente suporta vários outros idiomas da web. Basta selecionar um fragmento e vender a combinação - esse é o código multilíngue e comentado. Da mesma forma, ele pode ser ativado.
É tudo o que temos. Se você não usou esses recursos antes, recomendamos que você comece. As abreviações tornam o trabalho mais rápido e melhor.
JavaScript. Início rápido
Aprenda o básico do JavaScript com um exemplo prático de construção de um aplicativo da web
Comentários em PHP são semelhantes aos comentários usados em HTML. Na sintaxe PHP, os comentários sempre começam com uma sequência especial de caracteres, e qualquer texto que apareça entre esses caracteres especiais será ignorado pelo interpretador.
Em HTML, o objetivo principal de um comentário é servir como uma nota para os desenvolvedores que podem visualizar o código-fonte do seu site. Os comentários do PHP diferem porque não serão exibidos aos visitantes. A única maneira de visualizar os comentários do PHP é abrir o arquivo para edição. Isso torna os comentários PHP úteis apenas para programadores PHP.
Caso você tenha esquecido ou não saiba como os comentários são feitos em HTML, veja o exemplo abaixo.
Sintaxe de comentário php: comentário de linha única
Enquanto o html tem apenas um tipo de comentário, o PHP tem dois tipos. O primeiro tipo que discutiremos é o comentário de linha única. Ou seja, um comentário que diz ao intérprete para ignorar o que quer que aconteça naquela linha à direita dos comentários. Para usar este comentário, use os caracteres "//" ou "#" e todo o texto à direita será ignorado pelo interpretador PHP.
Psst...Você não pode ver meus comentários PHP!"; // echo "nada"; // echo "Meu nome é Humperdinkle!"; # echo "Eu também não faço nada"; ?>
Resultado:
Olá Mundo! Psst...Você não pode ver meus comentários em PHP!
Observe que vários de nossos comandos de eco não foram processados porque os comentamos com caracteres de comentário especiais. Esse tipo de comentário é frequentemente usado para escrever rapidamente sobre código complexo e ofuscado ou para remover temporariamente uma linha de código PHP (para fins de depuração).
Sintaxe de comentário php: comentário de várias linhas
Assim como os comentários em HTML, os comentários de várias linhas em PHP podem ser usados para comentar em grandes blocos de código ou para escrever comentários em várias linhas. Comentários de várias linhas em PHP começam com "/*" e terminam com "*/". Qualquer coisa entre esses caracteres será ignorada.
Resultado.
... hoje estamos neste artigo curto, mas útil, vamos descobrir como o código de programa diferente é comentado. Não vou falar muito, porque se você está interessado nisso, já encontrou as perguntas dessa tarefa e tem uma ideia sobre isso.
Você veio ao lugar certo... mas algumas palavras para clareza e utilidade. Você deve ter visto como é feito com código CSS, já que CSS é o que mais interessa a muitos iniciantes, como eu.
… Bom!
Mas observe que os comentários também são usados em html e php... Mas a maioria dos iniciantes se confunde no estágio inicial de seu trabalho com o site e não sabe como adicionar as explicações necessárias a si mesmo. Afinal, acontece da mesma forma, por exemplo, você precisa desativar por algum tempo Código HTML, e depois retome sua função novamente - isso é fácil de implementar se você fez anotações nas “margens”, mas nunca sabe o quê.
Mas o que deve ser lembrado sobre “comentários” em geral - tudo aqui depende estritamente de qual arquivo você está trabalhando especificamente e, portanto, o código do aplicativo é diferente.
Comentando o código CSS
a:hover, a:focus ( color: #D5071E; decoração de texto: Overline; /*sublinhado no topo*/ )É assim que você se explica. Ou você geralmente pode comentar este script css assim: apenas envolva
/* CODIGO aqui */
/*a:hover, a:focus ( color: #D5071E; decoração de texto: sublinhado; /*BOTTOM UNDERLINE*/ )*/
Chamo sua atenção para o fato de que - você pode comentar o ciclo completo do código css dessa maneira, mas !! então você terá que remover comentários repetidos /* UNDERSTRING ABAIXO */, ou brincar com barras se a explicação for importante))
Caso contrário, haverá um erro!!
Observação:
Se você abrir o código fonte da página - Ctrl + U e der uma olhada... veremos que o trecho de código css comentado está perfeitamente exibido no documento gerado! isto é se o css foi usado (as propriedades foram definidas) diretamente no html
E, como você entende, se você seguir o link do código-fonte para o documento css do seu modelo ativo, poderá observar e estudar todos os comentários)) se alguém precisar. Mas isso é improvável.)
O dialeto inglês (palavras) será legível. Símbolos russos - não.
Comentando o código HTML
O arquivo XML é comentado da mesma maneira.
Importante: verifique sempre o código proposto nos artigos, pelo menos visualmente, caso contrário podem ocorrer erros.
Um simples descuido na formatação pode custar tempo, por exemplo, o código COMENTADO mostrado acima costuma estar errado: em vez de dois hífens curtos, um travessão aparece:
Para a sua informação:
como mencionado na observação anterior - assim é o comentário ... o código html é exibido no documento gerado!
Mantenha isso em mente.
E aqui está outra coisa:
além do fato de que o código comentado é exibido no código-fonte da página (e, portanto, é processado em algum sentido, embora seja invisível na página!) - é melhor remover algumas funções do php em conjunto com o html do documento ativo.
Por exemplo:
será visível no documento e a funçãoele fará seu trabalho notavelmente bem: ou seja, no front-end as informações não serão visíveis, mas no código-fonte elas serão exibidas claramente! e este é um pedido bespontovy ao banco de dados: tudo isso é uma ninharia, mas você precisa saber!
É possível fazer isso se você não quiser retirar um pedaço de código do documento:
adicione antes da abertura de código html "extra" necessária… função inline… e fechamento?> …
Em uma palavra, isso é o que você pode fazer se o código for grande:
então a fonte estará limpa!
Ou mais simplesmente:
Vamos comentar a função em si no documento html. O código fonte nestes casos em relação ao desenvolvimento de funções será limpo!
como comentar javascript
if (beingShown || mostrado) ( // não aciona a animação novamente return; ) else ( // aplica QUALQUER COMENTÁRIO na linha // aplica QUALQUER COMENTÁRIO na linha // true;Este código JavaScript de amostra - eu, para maior clareza, peguei na rede, corrigindo um pouco a pontuação. Não importa... O principal é entender o princípio...
Como você entende, a barra “//” é dupla, este é o SINAL do comentário... SINGLE-LINE!
E o resto do código JS é comentado como php , mais sobre isso abaixo:
Nota:
Comentando o código PHP
... e ... aqui é semelhante - barra-barra ... linha única.Mas note que ele pode ser comentado assim como o código CSS.
... ou você pode comentar assim - uma versão de uma linha, quando usamos NÃO DUAS BARRAS, mas BEKAR (hash) antes da linha comentada:
…Claro, comentar deve ser feito com cuidado no loop de código!
... ou desta forma - semelhante ao exemplo CSS mostrado acima ... ou seja esta opção de comentário /* código */ é adequada para códigos CSS e JS!
Mas desta forma você pode comentar uma explicação mais volumosa do código PHP, em algum lugar entre seus principais exemplos ...
Você também pode comentar em ciclos php se o código estiver misturado ... php e de alguma forma html
Semelhante ao anterior:
Por exemplo, alguma dessas funções ... em algum lugar no código geral (ou um loop em html):- você pode comentar, ou seja, adicionar seu marcador assim:
ou assim: uma linha…
Inteligência:
código php não é visível em nenhum código fonte!! apenas seu resultado funcional é visível - funcionando!
Isso é tudo que eu queria relatar hoje!
Agora você pode experimentar... Boa sorte.
E claro, leia os artigos do site e se inscreva:
Compartilho minha amarga experiência - algum conhecimento, para seu doce bem-estar))
...a cidade dos webmasters Michalika.ru© - facilmente com WordPress