Comentários em código HTML, CSS, JS e PHP. Como escrever comentários html no código? Como fazer uma explicação em html

... hoje, neste artigo curto, mas útil, descobriremos como diferentes códigos de programas são comentados. Não vou falar muito, porque se você está interessado nisso, então você já enfrentou as questões desse problema, e você tem uma ideia dele.


Você veio ao endereço ... mas algumas palavras para maior clareza e benefício do caso. Você provavelmente já viu como isso é feito com o código CSS, já que o css é de grande interesse para muitos iniciantes, como eu.

… Boa!

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 somar as explicações necessárias a si mesmos. Afinal, acontece então, por exemplo, você precisa desativar Código HTML e, em seguida, retome sua função - é fácil de implementar se você fez anotações para si mesmo 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; text-decoration: Overline; / * UNDERLINE UP * /)

É assim que você se explica a si mesmo. Ou você pode até comentar este script css como este: basta embrulhar

/ * CODE aqui * /

/ * a: hover, a: focus (color: # D5071E; text-decoration: underline; / * UNDERLINE * /) * /

Chamo sua atenção para o fato de que - você pode comentar o ciclo completo do código css desta forma, mas !! então você terá que remover comentários repetidos / * UNDERLINE BOTTOM * /, ou brincar com barras, se a explicação for importante))

Caso contrário, ocorrerá um erro !!

Observação:

Se você abrir o código-fonte da página - Ctrl + U e dar uma olhada ... veremos que a parte comentada do código css é lindamente exibida no documento gerado! isto é, se css foi usado (as propriedades foram definidas) diretamente em html

E, como você sabe, se você for do código-fonte por referência ao documento css do seu modelo ativo - todos os comentários podem ser observados e estudados)) se alguém precisar. Mas isso é improvável)

O advérbio (palavras) em inglês será legível. Simbolismo russo - não.

Comentando o código HTML

O arquivo XML é comentado da mesma maneira.

Importante: sempre verifique o código fornecido nos artigos, pelo menos visualmente) caso contrário, podem haver erros.

O descuido usual na formatação pode ser demorado, por exemplo, o código COMENTEADO mostrado acima é frequentemente errado: em vez de dois hifens curtos, um travessão aparece:

Para a sua informação:

conforme mencionado na observação anterior - o mesmo ocorre com 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 (o que significa que é processado em certo sentido, embora também seja invisível na página!) - é melhor remover algumas funções php em conjunto com html do documento ativo.

Por exemplo:

estará visível no documento e a funçãoele funcionará maravilhosamente bem: ou seja, a informação não será vista no frontend, mas na fonte - será exibida claramente! e essa é uma solicitação bespontovy para o banco de dados: tudo isso é uma bagatela, mas você precisa saber!

É possível fazer isso se você não quiser retirar um trecho de código do documento:

adicione antes do código html "extra" necessário a abertura... função inline ... e fechando?> ...

Em uma palavra, é assim 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 será limpo em relação ao desenvolvimento das funções!

como comentar JavaScript

if (sendo mostrado || mostrado) (// não dispara a animação novamente return;) else (// na linha aplicar ANY COMMENT // na linha apply ANY COMMENT // true;

Para maior clareza, peguei este código JavaScript de exemplo na rede, ajustando levemente a pontuação. Não importa ... O principal é entender o princípio ...

Como você entende a barra "//" é dupla, este é o SINAL do comentário ... UMA LINHA!

O resto do código JS é comentado como php, mais sobre isso abaixo:

observação:

Comentando o código PHP

... e ... aqui é o mesmo - barra-barra ... uma linha.

Mas observe que ele pode ser anotado da mesma forma que o código CSS.

... ou então você pode comentar - uma opção de uma linha, quando usamos NÃO DUAS BARRAS, mas BECAR (hash) antes da linha comentada:

... Naturalmente, você precisa comentar cuidadosamente no loop de código!

... ou da mesma forma - semelhante ao exemplo acima para CSS ... ou seja, esta opção / * code * / commenting funcionará 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 loops php como este, se o código for misto ... php e de alguma forma html

Semelhante ao anterior:

Por exemplo, algum tipo de função ... em algum lugar no código geral (ou um loop em html):- você pode comentar, ou seja, adicionar seu próprio rótulo como este:

ou então: uma opção de uma linha ...

Inteligência:

o código php não é visível em nenhum código-fonte !! apenas seu resultado funcional é visível - trabalhando fora!

Em geral, 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 Mikhalika.ru© - Facilmente com WordPress

Michael 2016-05-05 1 HTML e CSS 2

Como escrever comentários html no código?

Hoje vou falar como fazer comentários no código em html. Os comentários são muito úteis. Eles não afetam de forma alguma a execução do código e a aparência das páginas, e ainda não podem ser vistos no código-fonte da página. Na verdade, os comentários só podem ser vistos abrindo o arquivo em um editor. No meu Notepad ++, eles são destacados em verde.

Como deixar comentários em html?

Muito fácil. A sintaxe de um comentário na linguagem de marcação é a seguinte:

Assim, você pode comentar não apenas uma linha, mas várias. A principal coisa a lembrar é que- fechamento. Dentro de tal construção, você pode usar apenas um texto explicativo e tags entre colchetes angulares, o navegador não as lerá.

Como eu disse, o comentário possui os seguintes recursos:

  1. não é visível na página
  2. e no código-fonte também, não, mas apenas ao editar um arquivo
  3. todas as tags que são colocadas nele não serão processadas pelo navegador de forma alguma

Para que serve

O principal objetivo dos comentários é ajudar outros desenvolvedores. Ao codificar, você pode indicar explicitamente qual parte do código forma o cabeçalho e qual parte forma a parte principal. Claro, programadores experientes teriam descoberto sem ele, mas ler e entender o código ainda está melhorando. E também os comentários ajudam quem não entende bem o html, afinal, pelo menos um pouco a entender o que foi escrito. Aqui está um exemplo de seu uso:

O segundo uso possível de um comentário é tornar algum trecho de código inativo por um tempo, quando você não gostaria de excluí-lo, mas precisa de alguma forma tornar sua execução inativa. A propósito, isso pode ajudar a identificar vários erros de layout.

Em geral, uma das boas qualidades de qualquer desenvolvedor da Web é a capacidade de escrever um código bem projetado e compreensível. Isso significa que você precisa usar recuo, mostrando o aninhamento de elementos, também deixar comentários se necessário, separar as partes principais do documento com quebras de linha, etc. Tudo isso auxilia quem futuramente editará o código, assim como o próprio autor, que não se perderá em sua própria criação.

Vou começar este artigo com a finalidade dos comentários. Suponha que você esteja desenvolvendo um módulo com uma estrutura complexa. Ou você faz um layout com muitos anexos de elementos. Nesses casos, é melhor marcar algumas partes do código de alguma forma - para isso, há comentários.

Agora vou mostrar em detalhes os quatro tipos de comentários, mais precisamente, todos os seus tipos para quatro códigos diferentes.

Comentários HTML

Para adicionar um comentário à marcação HTML, use:

Tudo o que está nessas tags não fica visível na tela, mas fica disponível para visualização no código-fonte.

Comentários em estilos CSS

Para adicionar um comentário aos estilos CSS, use:

Tudo o que está nessas tags não é levado em consideração na formação de estilos, mas está disponível para visualização no próprio arquivo de estilos.

Comentários de JavaScript

Para adicionar comentários em JavaScript, existem seus dois tipos.

Primeiro tipo:

// Texto, código ou outro

Segundo tipo:

/ * Texto, código ou outro * /

Tudo o que está nessas tags não é levado em consideração quando o script é executado, mas fica disponível para visualização no próprio arquivo JavaScript.

Comentários em código PHP

Esta linguagem de programação, ao contrário das anteriores, tem 3 tipos de comentários.

Primeiro tipo:

// Texto, código ou outro

Segundo tipo:

/ * Texto, código ou outro * /

E o terceiro tipo:

# Texto, código ou outro

Tudo o que está nessas tags não é levado em consideração ao executar o script e é visível apenas no próprio arquivo PHP.

Observação!

/ * / * Meu código * / * /

dará a você um erro.

Nesta lição, falarei sobre como fazer comentários em HTML, CSS, PHP... Os comentários são textos que não estão visíveis na página da web. Eles são usados ​​para todos os tipos de explicações, lembretes, descrições para webmasters, o que permite estruturar o documento. Os comentários são indispensáveis ​​ao depurar o código, eles permitem que você navegue rapidamente na marcação de uma página da web e encontre o bloco que você precisa. Freqüentemente, os comentários são usados ​​para depurar o código HTML. Por exemplo, você pode comentar temporariamente um bloco específico de código para que ele não seja executado e, se necessário, pode ser facilmente restaurado.

Comentários HTML

Em HTML, os comentários são formados por símbolos:... Portanto, qualquer texto entre esses símbolos é um comentário. Vamos considerar um exemplo:

Comentários em CSS

Os comentários CSS são criados usando os símbolos: / * e * /. Para criar um comentário, você só precisa colocar o código da página da web entre estes símbolos:

/ * Início do bloco com estilos para Body * / body (background: #efeded; font-family: Verdana, Helvetica, sans-serif; font-size: 12px; margem: 0px; preenchimento: 0px;) / * Fim do bloco com estilos para Body * /

Comentários PHP

Os comentários do PHP podem ser de uma ou várias linhas:

1) Comentários de linha única em PHP são criados usando os símbolos: //. Basta colocar este símbolo antes da linha e ele será comentado.Esta opção é usada no caso em que o comentário consiste em apenas uma linha.

2) Para implementar comentários de várias linhas, os seguintes símbolos são usados: / * e * /. Esta opção é útil se o comentário se estender por várias linhas.

Assim, aprendemos a fazer

No trabalho de um programador, você deve constantemente fazer algumas anotações na forma de comentários, a fim de descrever uma parte do código ou marcas para o futuro. Cada linguagem tem sua própria sintaxe, por isso, no desenvolvimento de páginas web, um problema comum é não saber comentar uma linha em HTML ou apenas um pequeno bloco de uma vez.

Comentários HTML

Ao desenvolver uma página web, às vezes é necessário ocultar uma parte do código por um tempo ou fazer uma nota para o programador. Para não usar aplicativos adicionais, por exemplo, transferir parte do código para outro arquivo, você precisa saber como comentar uma linha em HTML.

Ao contrário da maioria das linguagens de programação, o HTML não tem uma função ou tag especial para criar um comentário de uma linha. Se você precisar "ocultar" apenas uma linha ou parte dela, deverá usar o kit de ferramentas de linguagem clássico. No entanto, existem várias maneiras de fazer isso.

Comentário padrão

Em HTML, a maneira mais fácil de comentar um trecho de código é usar pares de caracteres especiais. Antes de começar um comentário, você deve especificar "". Assim, tudo dentro desta estrutura ficará oculto do usuário quando a página for carregada.

Deve-se observar que, ao trabalhar com um comentário, você deve ser extremamente cuidadoso. Ao definir seus limites, você precisa verificar se alguma tag de abertura ou fechamento caiu nele, a segunda parte da qual permaneceu fora dela - neste caso, o carregamento da página estará incorreto. Além disso, você não pode criar vários outros dentro de um comentário - com esta escrita, o primeiro sinal para o final da parte do comentário abrirá toda a parte subsequente do texto oculto.

Abaixo está um exemplo de grafia correta:

Este é um comentário.

Marcação

Em HTML, você também pode comentar as linhas usando um par especial de tags - ... Ele é incluído especificamente na sintaxe da linguagem para esse propósito, mas a maioria dos navegadores populares não o suporta, com exceção do Internet Explorer 8.0. Marcação Útil quando algumas informações precisam ser ocultadas apenas para IE 8.0, 4.0 e anteriores, ou como uma solução temporária durante o desenvolvimento. O ponto específico aqui é que você pode comentar uma parte do código apenas no corpo da página, ou seja, dentro da tag .

No exemplo abaixo, quando a página é carregada nos navegadores especificados, uma folha em branco será exibida, em outros programas a página será escrita:

Isto é um comentário

.

Abordagem não convencional

Além dos métodos clássicos, você pode comentar o código em HTML usando métodos específicos. Além das estruturas básicas da linguagem HTML, as tags de script e de folha de estilo são frequentemente especificadas no corpo da página. Cada um deles também tem suas próprias definições de comentários.

Portanto, se você incluir a parte necessária do código em uma das tags especificadas, poderá usar outros métodos para comentar parte do código na página HTML. Tais métodos praticamente não são usados ​​na prática moderna, porém, para autodesenvolvimento ou, se necessário, para excluir a possível aparição de texto na página, eles podem ser aplicados.

Ao usar uma tag de script ou folha de estilo, os comentários podem ter uma ou várias linhas. Os primeiros são definidos pela construção "//", que, a partir do momento da escrita desses personagens, comenta o resto da linha. Para ocultar uma parte do código, use a descrição da sintaxe "/ *" para abrir e "* /" para fechar um comentário. Se a construção de fechamento não for escrita após os símbolos "/ *", todo o código HTML restante será comentado.

O exemplo apresentado mostra uma forma de comentários fora do padrão:

/*

Это комментарий.

*/