Skip to content

Commit 1320994

Browse files
authored
Apply suggestions from code review
1 parent 205e87f commit 1320994

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

1-js/03-code-quality/04-ninja-code/article.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Isso fará com que seja bem mais difícil identificar o que exatamente está den
145145
Por exemplo:
146146

147147
```js
148-
function funcaoNinja(elem) {
148+
function ninjaFunction(elem) {
149149
// 20 linhas de código trabalhando com elem
150150

151151
elem = clone(elem);
@@ -170,7 +170,7 @@ Um ninja inteligente põe sublinhas em uma parte do código e evita elas em outr
170170

171171
Faça com que todos vejam a grandiosidade das suas entidades! Nomes como `superElemento`, `megaFrame` e `itemLegal` com certeza irão iluminar um leitor.
172172

173-
Aliás, por um lado, algo é escrito como: `super..`, `mega..`, `legal..` Mas por outro -- isso não traz detalhe nenhum. Um leitor talvez decida procurar por um signifcado oculto e meditar por uma hora ou duas.
173+
Aliás, por um lado, algo é escrito como: `super..`, `mega..`, `nice..` Mas por outro -- isso não traz detalhe nenhum. Um leitor talvez decida procurar por um signifcado oculto e meditar por uma hora ou duas.
174174

175175

176176

@@ -184,10 +184,10 @@ Quando na escuridão, pode ver tudo na luz.
184184
Use os mesmos nomes para variáveis dentro e fora de uma função. Bem simples. Sem esforço.
185185

186186
```js
187-
let *!*usuario*/!* = autenticaUsuario();
187+
let *!*user*/!* = autenticateUser();
188188

189189
function render() {
190-
let *!*usuario*/!* = outroValor();
190+
let *!*user*/!* = anotherValue();
191191
...
192192
...muitas linhas...
193193
...
@@ -196,22 +196,22 @@ function render() {
196196
}
197197
```
198198

199-
Um programador que olhar dentro de `render` provavelmente vai falhar em notar que já existe um `usuario` local substituindo a variável exterior à função.
199+
Um programador que olhar dentro de `render` provavelmente vai falhar em notar que já existe um `user` local substituindo a variável exterior à função.
200200

201-
Então ele vai tentar trabalhar com `usuario` assumindo que é a variável exterior, o resultado de `autenticaUsuario()`... A armadilha tá feita! Olá, debugger...
201+
Então ele vai tentar trabalhar com `user` assumindo que é a variável exterior, o resultado de `authenticateUser()`... A armadilha tá feita! Olá, debugger...
202202

203203

204204
## Efeitos colaterais em todo lugar!
205205

206-
Existem funções que parecem que não alteram nada. Como `estaPronto()`, `checaPermissao()`, `encontraTags()`... Elas são feitas para realizar cálculos, encontrar e retornar o dado, sem mudar nada fora delas. Em outras palavras, sem "efeito colateral".
206+
Existem funções que parecem que não alteram nada. Como `isReady()`, `checkPermission()`, `findTags()`... Elas são feitas para realizar cálculos, encontrar e retornar o dado, sem mudar nada fora delas. Em outras palavras, sem "efeito colateral".
207207

208208
**Um truque ótimo é adicionar uma ação "útil" a elas, além da sua tarefa principal.**
209209

210-
Uma expressão de surpresa atordoada na cara dos seus colegas quando eles virem uma função com nome `é...`, `checa...` ou `encontra...` mudando alguma coisa -- vai definitivamente ampliar seus limites da razão.
210+
Uma expressão de surpresa atordoada na cara dos seus colegas quando eles virem uma função com nome `is..`, `check..` ou `find..` mudando alguma coisa -- vai definitivamente ampliar seus limites da razão.
211211

212212
**Uma outra forma de surpreender é retornar um valor não padrão.**
213213

214-
Mostre o que é pensar fora da caixa! Faça com que a chamada de `checaPermissao` retorne não um `true/false`, mas sim um complexo objeto com o resultado da checagem.
214+
Mostre o que é pensar fora da caixa! Faça com que a chamada de `checkPermission` retorne não um `true/false`, mas sim um complexo objeto com o resultado da checagem.
215215

216216
Aqueles desenvolvedores que tentarem escrever `if (checaPermissao(..))`, vai se perguntar por que não funciona. Diga a eles: "Leia a documentação!". E mostre este artigo.
217217

0 commit comments

Comments
 (0)