Skip to content

Commit 67d6f9f

Browse files
committed
#2 [add] HTML comments
1 parent c61de76 commit 67d6f9f

File tree

1 file changed

+33
-15
lines changed

1 file changed

+33
-15
lines changed

translations/pt_BR/README.md

Lines changed: 33 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,20 @@
1010
## Sumário
1111

1212
* 1. [Global](#global)
13-
* 1.1 [Identação](#identação)
13+
* 1.1 [Identation](#identation)
1414
* 2. [Commits](#commits)
15-
* 2.1 [Em inglês]()
16-
* 2.2 [Número da tarefa]()
17-
* 2.3 [Status]()
18-
* 2.4 [Convenção da mensagem]()
15+
* 2.1 [English](#english)
16+
* 2.2 [Task number](#task-number)
17+
* 2.3 [Status](#status)
18+
* 2.4 [Message convention](#message-convention)
1919
* 3. [HTML](#html)
20-
* 3.1 [Commentários](#comentarios)
21-
* 4. [CSS](#css)
22-
* 5. [SCSS](#scss)
23-
* 6. [JavaScript](#javascript)
20+
* 3.1 [Comentários](#comments)
21+
* 4. [CSS / SCSS](#css--scss)
22+
* 5. [JavaScript](#javascript)
2423

2524
### Global
2625

27-
#### Identação
26+
#### Identation
2827

2928
O estilo de identação é usando espaços e o tamanho da identação é 2.
3029

@@ -61,11 +60,11 @@ trim_trailing_whitespace = false
6160

6261
### Commits
6362

64-
#### Em inglês
63+
#### English
6564

6665
Para a contribuiição em projetos, a mensagem do **commit**, título do **pull request** e a **issue**, devem ser escritos em inglês.
6766

68-
#### Número da tarefa
67+
#### Task number
6968

7069
Tendo uma `issue` ou uma tarefa no Trello, Jira ou outro software de gerenciamento de tarefas para 1 ou mais commits, informar no começo da mensagem do mesmo.
7170

@@ -80,7 +79,7 @@ Para facilitar, a mensagem deverá ter os seguintes status:
8079

8180
O `status` será informado na mensagem entre colchetes. E poderá ser interpretado como status de um arquivo ou trecho de código.
8281

83-
#### Convenção da mensagem
82+
#### Message convention
8483

8584
Usar letras minúsculas
8685

@@ -96,16 +95,35 @@ git commit -m "my first commit"
9695

9796
#### 1. Comentários
9897

98+
O uso mais frequente de comentários no HTMl, é para sinalizar o fechamento de uma tag. O caractere `/` seria o mesmo que escrever `end`. A preferência na identificação da tag, é por sua classe.
99+
99100
```html
100-
<div class="container">
101+
<!-- Good -->
102+
<div class="container" id="section">
101103
</div><!-- /container -->
104+
105+
<!-- Bad -->
106+
<div class="container" id="section">
107+
</div><!-- section -->
102108
```
103109

110+
O ideal é que os comentários não estejam no ambiente de produção, sendo apenas uma orientação para o desenvolvimento. Também podemos ter um bloco de comentários para facilitar o entendimento.
111+
104112
```html
113+
<!-- Good -->
105114
<!--
115+
Comment block ...
106116
-->
107-
```
117+
<div></div>
108118

119+
<!-- Bad -->
120+
<!--
121+
###############################################################
122+
# Comment block ...
123+
###############################################################
124+
-->
125+
<div></div>
126+
```
109127

110128
## Contribuindo
111129

0 commit comments

Comments
 (0)