x/clean-code-typescript
1
0
Fork 0
mirror of https://github.com/labs42io/clean-code-typescript.git synced 2025-04-19 23:33:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

TODO comments

Browse source
This commit is contained in:
Vitor Freitas 2019-02-13 19:05:14 -03:00
parent d9c0093ff5
commit 1bfb155db3
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -2652,4 +2652,30 @@ class Client {
**[⬆ ir para o topo](#table-of-contents)**
### Comentários de TODO
Quando você reparar que precisa deixar notas no código, para alterar coisas futuramente, faça isso utilizando comentários `// TODO`. A maioria das IDEs tem um suporte especial para esse tipo de comentário para que possa voltar nesses comentários mais fácilmente depois.
Tenha em mente que *TODO*s não são uma desculpa para código ruim.
**Ruim:**
```ts
function getActiveSubscriptions(): Promise<Subscription[]> {
// garantir que `dueDate` está indexado
return db.subscriptions.find({ dueDate: { $lte: new Date() } });
}
```
**Bom:**
```ts
function getActiveSubscriptions(): Promise<Subscription[]> {
// TODO: garantir que `dueDate` está indexado.
return db.subscriptions.find({ dueDate: { $lte: new Date() } });
}
```
**[⬆ ir para o topo](#table-of-contents)**
Um grande obrigado ao meu amigo [Luís Gustavo](https://github.com/lgustavogdc) que me deu uma força ao traduzir esse conteúdo maravilhoso!