From 1bfb155db3bdcdb2155bc538ddd7109584b59267 Mon Sep 17 00:00:00 2001 From: Vitor Freitas Date: Wed, 13 Feb 2019 19:05:14 -0300 Subject: [PATCH] TODO comments --- README.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/README.md b/README.md index 092b50c..ebb2de7 100644 --- a/README.md +++ b/README.md @@ -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 { + // garantir que `dueDate` está indexado + return db.subscriptions.find({ dueDate: { $lte: new Date() } }); +} +``` + +**Bom:** + +```ts +function getActiveSubscriptions(): Promise { + // 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!