-
Notifications
You must be signed in to change notification settings - Fork 38
/
index.html
1399 lines (1310 loc) · 71.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="pt-BR">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Código Limpo (Clean Code) | balta.io</title>
<meta name="description"
content="Clean Code ou código limpo se refere a um conjunto de boas práticas na escrita de software que você pode aplicar para obter uma maior legibilidade e manutenabilidade do seu código.">
<meta name="keywords" content="clean code, cleancode, codigo limpo">
<meta name="author" content="balta.io">
<!--Twitter Share-->
<meta name="twitter:card" content="summary_large_image" />
<meta name="twitter:site" content="https://codigo-limpo.net/" />
<meta name="twitter:creator" content="@balta_io" />
<meta name="twitter:title" content="Código Limpo (Clean Code)" />
<meta name="twitter:description"
content="Clean Code ou código limpo se refere a um conjunto de boas práticas na escrita de software que você pode aplicar para obter uma maior legibilidade e manutenabilidade do seu código." />
<meta name="twitter:image"
content="https://baltaio.blob.core.windows.net/static/images/articles/clean-code_share.jpg" />
<!--Facebook/LinkedIn Share-->
<meta property="og:url" content="https://codigo-limpo.net/" />
<meta property="og:title" content="Código Limpo (Clean Code)" />
<meta property="og:description"
content="Clean Code ou código limpo se refere a um conjunto de boas práticas na escrita de software que você pode aplicar para obter uma maior legibilidade e manutenabilidade do seu código." />
<meta property="og:image"
content="https://baltaio.blob.core.windows.net/static/images/articles/clean-code_share.jpg" />
<link rel="icon" type="image/x-icon"
href="https://baltaio.blob.core.windows.net/static/images/icons/favicon.ico?v1" />
<link rel="shortcut icon" type="image/x-icon"
href="https://baltaio.blob.core.windows.net/static/images/icons/favicon.ico?v1" />
<link rel="stylesheet" href="https://baltaio.blob.core.windows.net/static/css/uikit.balta.dark.css?v1" />
<link rel="stylesheet" href="/css/site.css?v=Xf9wDwoEu67xOdNRvXvQdyfFF6GZqkqgMYikpsnQG3o">
</head>
<body>
<main>
<div class="uk-container uk-margin-large-top">
<div class="uk-flex uk-flex-between" uk-grid>
<div class="uk-width-1-1@m">
<article>
<img src="https://baltaio.blob.core.windows.net/static/images/dark/balta-logo.svg" width="150"
alt="Código Limpo (Clean Code)" />
<br>
<h1>Código Limpo (Clean Code)</h1>
<p>Aprenda ou consolide todos os conhecimentos necessários para trabalhar com C# e .NET!
</p>
<p>Clean Code ou código limpo se refere a um conjunto de boas práticas na escrita de software
que você pode aplicar para obter uma maior legibilidade e manutenabilidade do seu código.
</p>
<p><img src="https://baltaio.blob.core.windows.net/static/images/articles/clean-code_share.jpg"
alt="Clean Code" title="Clean Code" /></p>
<h2 id="índice">Índice</h2>
<ul>
<li><a href="#%C3%ADndice">Índice</a></li>
<li><a href="#o-que-%C3%A9-o-clean-code">O que é o Clean Code?</a></li>
<li><a href="#regras-gerais">Regras gerais</a>
<ul>
<li><a href="#siga-as-conven%C3%A7%C3%B5es">Siga as convenções</a></li>
<li><a href="#kiss">KISS</a></li>
<li><a href="#regra-do-escoteiro">Regra do escoteiro</a></li>
<li><a href="#causa-raiz">Causa raiz</a></li>
</ul>
</li>
<li><a href="#regras-de-design">Regras de design</a>
<ul>
<li><a href="#mantenha-dados-de-configura%C3%A7%C3%A3o-em-alto-n%C3%ADvel">Mantenha
dados de configuração em alto nível</a>
<ul>
<li><a href="#exemplo">Exemplo</a></li>
</ul>
</li>
<li><a href="#polimorfismo-no-lugar-de-ifs">Polimorfismo no lugar de IFs</a>
<ul>
<li><a href="#exemplo-1">Exemplo</a></li>
</ul>
</li>
<li><a href="#mult-thread">Mult-thread</a>
<ul>
<li><a href="#exemplo-2">Exemplo</a></li>
</ul>
</li>
<li><a href="#separe-os-c%C3%B3digos-mult-thread">Separe os códigos mult-thread</a>
<ul>
<li><a href="#exemplo-3">Exemplo</a></li>
</ul>
</li>
<li><a href="#utilize-async-como-sufixo">Utilize Async como sufixo</a></li>
<li><a href="#evite-configura%C3%A7%C3%B5es-desnecess%C3%A1rias">Evite configurações
desnecessárias</a>
<ul>
<li><a href="#exemplo-4">Exemplo</a></li>
</ul>
</li>
<li><a href="#utilize-inje%C3%A7%C3%A3o-de-depend%C3%AAncia">Utilize injeção de
dependência</a>
<ul>
<li><a href="#exemplo-5">Exemplo</a></li>
</ul>
</li>
<li><a href="#lei-de-demeter">Lei de Demeter</a>
<ul>
<li><a href="#exemplo-6">Exemplo</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#regras-sobre-entendimento-do-c%C3%B3digo">Regras sobre entendimento do
código</a>
<ul>
<li><a href="#seja-consistente">Seja consistente</a>
<ul>
<li><a href="#exemplo-7">Exemplo</a></li>
</ul>
</li>
<li><a href="#utilize-vari%C3%A1veis-concisas">Utilize variáveis concisas</a>
<ul>
<li><a href="#exemplo-8">Exemplo</a></li>
</ul>
</li>
<li><a href="#obsess%C3%A3o-primitiva">Obsessão primitiva</a>
<ul>
<li><a href="#exemplo-9">Exemplo</a></li>
</ul>
</li>
<li><a href="#evite-depend%C3%AAncias-l%C3%B3gicas">Evite dependências lógicas</a>
<ul>
<li><a href="#exemplo-10">Exemplo</a></li>
</ul>
</li>
<li><a href="#evite-condicionais-negativas">Evite condicionais negativas</a>
<ul>
<li><a href="#exemplo-11">Exemplo</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#regras-de-nomes">Regras de nomes</a>
<ul>
<li><a href="#escolha-nomes-descritivos">Escolha nomes descritivos</a>
<ul>
<li><a href="#exemplo-12">Exemplo</a></li>
</ul>
</li>
<li><a href="#fa%C3%A7a-distin%C3%A7%C3%B5es-significantes">Faça distinções
significantes</a>
<ul>
<li><a href="#exemplo-13">Exemplo</a></li>
</ul>
</li>
<li><a href="#utilize-nomes-pronunci%C3%A1veis-e-busc%C3%A1veis">Utilize nomes
pronunciáveis e buscáveis</a>
<ul>
<li><a href="#exemplo-14">Exemplo</a></li>
</ul>
</li>
<li><a href="#evite-uso-excessivo-de-strings">Evite uso excessivo de strings</a>
<ul>
<li><a href="#exemplo-15">Exemplo</a></li>
</ul>
</li>
<li><a href="#n%C3%A3o-use-prefixo-ou-caracteres-especiais">Não use prefixo ou
caracteres especiais</a>
<ul>
<li><a href="#exemplo-16">Exemplo</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#regras-para-fun%C3%A7%C3%B5es-ou-m%C3%A9todos">Regras para funções ou
métodos</a>
<ul>
<li><a href="#pequenas-e-com-apenas-um-objetivo">Pequenas e com apenas um
objetivo</a>
<ul>
<li><a href="#exemplo-17">Exemplo</a></li>
</ul>
</li>
<li><a href="#utilize-nomes-descritivos">Utilize nomes descritivos</a>
<ul>
<li><a href="#exemplo-18">Exemplo</a></li>
</ul>
</li>
<li><a href="#opte-por-poucos-par%C3%A2metros">Opte por poucos parâmetros</a>
<ul>
<li><a href="#exemplo-19">Exemplo</a></li>
</ul>
</li>
<li><a href="#cuidado-com-efeitos-colaterais">Cuidado com efeitos colaterais</a>
<ul>
<li><a href="#exemplo-20">Exemplo</a></li>
</ul>
</li>
<li><a href="#n%C3%A3o-tome-decis%C3%B5es-desnecess%C3%A1rias">Não tome decisões
desnecessárias</a>
<ul>
<li><a href="#exemplo-21">Exemplo</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#regras-de-coment%C3%A1rios">Regras de comentários</a>
<ul>
<li><a href="#um-c%C3%B3digo-bom-%C3%A9-expressivo">Um código bom é expressivo</a>
</li>
<li><a href="#n%C3%A3o-seja-redundante">Não seja redundante</a>
<ul>
<li><a href="#exemplo-22">Exemplo</a></li>
</ul>
</li>
<li><a href="#n%C3%A3o-feche-os-coment%C3%A1rios">Não feche os comentários</a>
<ul>
<li><a href="#exemplo-23">Exemplo</a></li>
</ul>
</li>
<li><a href="#evite-c%C3%B3digos-comentados">Evite códigos comentados</a>
<ul>
<li><a href="#exemplo-24">Exemplo</a></li>
</ul>
</li>
<li><a href="#inte%C3%A7%C3%A3o">Inteção</a>
<ul>
<li><a href="#exemplo-25">Exemplo</a></li>
</ul>
</li>
<li><a href="#esclarecimento">Esclarecimento</a>
<ul>
<li><a href="#exemplo-26">Exemplo</a></li>
</ul>
</li>
<li><a href="#consequ%C3%AAncias">Consequências</a>
<ul>
<li><a href="#exemplo-27">Exemplo</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#estrutura-do-c%C3%B3digo">Estrutura do código</a>
<ul>
<li><a href="#separe-conceitos-verticalmente">Separe conceitos verticalmente</a>
<ul>
<li><a href="#exemplo-28">Exemplo</a></li>
</ul>
</li>
<li><a href="#declare-vari%C3%A1veis-pr%C3%B3ximas-de-seu-uso">Declare variáveis
próximas de seu uso</a>
<ul>
<li><a href="#exemplo-29">Exemplo</a></li>
</ul>
</li>
<li><a href="#agrupe-funcionalidades-similares">Agrupe funcionalidades similares</a>
<ul>
<li><a href="#exemplo-30">Exemplo</a></li>
</ul>
</li>
<li><a href="#declare-fun%C3%A7%C3%B5es-de-cima-para-baixo">Declare funções de cima
para baixo</a>
<ul>
<li><a href="#exemplo-31">Exemplo</a></li>
</ul>
</li>
<li><a href="#mantenha-poucas-e-curtas-linhas">Mantenha poucas e curtas linhas</a>
<ul>
<li><a href="#exemplo-32">Exemplo</a></li>
</ul>
</li>
<li><a href="#n%C3%A3o-use-alinhamento-horizontal">Não use alinhamento
horizontal</a>
<ul>
<li><a href="#exemplo-33">Exemplo</a></li>
</ul>
</li>
<li><a href="#use-os-espa%C3%A7os-em-branco-corretamente">Use os espaços em branco
corretamente</a>
<ul>
<li><a href="#exemplo-34">Exemplo</a></li>
</ul>
</li>
<li><a href="#n%C3%A3o-quebre-a-identa%C3%A7%C3%A3o">Não quebre a identação</a>
<ul>
<li><a href="#exemplo-35">Exemplo</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#objetos-e-estruturas">Objetos e estruturas</a>
<ul>
<li><a href="#esconda-estruturas-internas">Esconda estruturas internas</a>
<ul>
<li><a href="#exemplo-36">Exemplo</a></li>
</ul>
</li>
<li><a href="#opte-por-estrutura-de-dados">Opte por estrutura de dados</a>
<ul>
<li><a href="#exemplo-37">Exemplo</a></li>
</ul>
</li>
<li><a href="#evite-usar-dados-e-objetos-juntos">Evite usar dados e objetos
juntos</a></li>
<li><a href="#instanciar-poucas-vari%C3%A1veis">Instanciar poucas variáveis</a>
<ul>
<li><a href="#exemplo-38">Exemplo</a></li>
</ul>
</li>
<li><a href="#classe-base-n%C3%A3o-deve-saber-sobre-suas-derivadas">Classe base não
deve saber sobre suas derivadas</a>
<ul>
<li><a href="#exemplo-39">Exemplo</a></li>
</ul>
</li>
<li><a href="#mais-m%C3%A9todos-menos-tomadas-de-decis%C3%A3o">Mais métodos, menos
tomadas de decisão</a>
<ul>
<li><a href="#exemplo-40">Exemplo</a></li>
</ul>
</li>
<li><a href="#evite-m%C3%A9todos-est%C3%A1ticos">Evite métodos estáticos</a></li>
</ul>
</li>
<li><a href="#testes">Testes</a>
<ul>
<li><a href="#um-assert-por-teste">Um assert por teste</a></li>
<li><a href="#leg%C3%ADvel">Legível</a>
<ul>
<li><a href="#exemplo-41">Exemplo</a></li>
</ul>
</li>
<li><a href="#r%C3%A1pido">Rápido</a>
<ul>
<li><a href="#exemplo-42">Exemplo</a></li>
</ul>
</li>
<li><a href="#independentes">Independentes</a>
<ul>
<li><a href="#exemplo-43">Exemplo</a></li>
</ul>
</li>
<li><a href="#repetit%C3%ADvel">Repetitível</a>
<ul>
<li><a href="#exemplo-44">Exemplo</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#code-smells">Code smells</a>
<ul>
<li><a href="#rigidez">Rigidez</a></li>
<li><a href="#fragilidade">Fragilidade</a></li>
<li><a href="#imobilidade">Imobilidade</a></li>
<li><a href="#complexidade-desnecess%C3%A1ria">Complexidade desnecessária</a></li>
<li><a href="#repeti%C3%A7%C3%A3o-desnecess%C3%A1ria">Repetição desnecessária</a>
</li>
<li><a href="#opacidade">Opacidade</a></li>
</ul>
</li>
<li><a href="#fontes">Fontes</a></li>
</ul>
<h2 id="o-que-é-o-clean-code">O que é o Clean Code?</h2>
<p>Por que estamos falando tanto sobre código limpo (Clean Code) e por que isto é tão importante
para nós? De fato a manutenção de um software é tão importante quanto sua construção.</p>
<p>Como relatado por Robert C. Martin em seu livro clássico, <em>Clean Code</em>, um Best Seller
da nossa área, algumas práticas e visões são importantíssimas para mantermos a <em>vida</em>
do nosso software.</p>
<blockquote>
<p><strong>IMPORTANTE</strong> Este artigo não descarta a leitura do livro, que é muito mais
denso e profundo sobre o assunto.</p>
</blockquote>
<p>As empresas investem milhões em softwares todo ano, mas com tantas mudanças no time e nas
tecnologias, como fazer este investimento durar? Como garantir uma boa manutenção,
durabilidade, vida ao software? Segundo Uncle Bob, as práticas abaixo são o caminho.</p>
<h2 id="regras-gerais">Regras gerais</h2>
<h3 id="siga-as-convenções">Siga as convenções</h3>
<p>Se você começou agora em um projeto ou acabaram de definir suas convenções, siga-as! Se
utilizam por exemplo constantes em maiúsculo, enumeradores com <strong>E</strong> como
prefixo, não importa! Siga sempre os padrões do projeto.</p>
<h3 id="kiss">KISS</h3>
<p>Mantenha as coisas simples! Este conceito vem até de outro livro, e particularmente acho que
é a base de uma boa solução. Normalmente tendemos a complicar as coisas que poderiam ser
muito mais simples.</p>
<p>Então, Keep It Stupid Simple (Mantenha isto estupidamente simples - KISS)!</p>
<h3 id="regra-do-escoteiro">Regra do escoteiro</h3>
<p>"Deixe sempre o acamapamento mais limpo do que você encontrou!" O mesmo vale para
nosso código. Devolva (Check in) sempre o código melhor do que você o obteve. Se todo
desenvolvedor no time tiver esta visão, e devolver um pedacinho de código melhor do que
estava antes, em pouco temos teremos uma grande mudança.</p>
<h3 id="causa-raiz">Causa raiz</h3>
<p>Sempre procure a causa raiz do problema, nunca resolva as coisas superficialmente. No
dia-a-dia, na correria, tendemos a corrigir os problemas superficialmente e não adentrar
neles, o que muitas vezes causa o re-trabalho!</p>
<p>Tente sempre procurar a causa raiz e resolver assim o problema de uma vez por todas!</p>
<h2 id="regras-de-design">Regras de design</h2>
<h3 id="mantenha-dados-de-configuração-em-alto-nível">Mantenha dados de configuração em alto
nível</h3>
<p>Algo que toda aplicação tem são suas configurações, como as conhecidas
<strong>ConnectionStrings</strong>. Tente sempre deixar estas configurações ou o
<em>parse</em> delas em um nível mais alto possível.
</p>
<p>Evite sobrescrever configurações em métodos dentro de <strong>Controllers</strong> ou algo do
tipo. Se possível, mantenha esta passagem no método principal, no início da aplicação e não
mexa mais nisto!</p>
<h4 id="exemplo">Exemplo</h4>
<p>Em diversas aplicações que trabalho, crio sempre uma classe <strong>Settings</strong> no
projeto base e depois no <strong>Startup</strong> das aplicações populo ela com as
configurações. Isto garante que não teremos estas configurações sendo escritas em todo lugar
e também que não precisaremos do <strong>IConfiguration</strong> que fica no
<strong>ASP.NET</strong> em projetos que não são Web.
</p>
<p><small><strong>MeuProjeto.Domain</strong></small></p>
<pre><code class="language-csharp">public static class Settings {
public static string ConnectionString { get; set; }
}
</code></pre>
<p><small><strong>MeuProjeto.Api</strong></small></p>
<pre><code class="language-csharp">public Startup(IConfiguration configuration)
{
Configuration = configuration;
Settings.ConnectionString = Configuration.GetConnectionString("connectionString");
}
</code></pre>
<p><small><strong>MeuProjeto.Infra</strong></small></p>
<pre><code class="language-csharp">using(var connection = new SqlConnection(Settings.ConnectionString)) {
...
}
</code></pre>
<h3 id="polimorfismo-no-lugar-de-ifs">Polimorfismo no lugar de IFs</h3>
<p>Um <strong>IF</strong> ou condicional, como o nome diz, traz uma tomada de decisão a nossa
aplicação, o que implica no aumento da complexidade da mesma. No geral devemos evitar o uso
excessivo destes.</p>
<p>Nestes cenários, opte sempre pelo <a
href="https://balta.io/blog/orientacao-a-objetos">polimorfismo</a> ao invés de tomar
decisão em todo método que cria.</p>
<h4 id="exemplo-1">Exemplo</h4>
<p>Vamos tomar como base uma classe <strong>Pagamento</strong>, onde temos pagamento via Boleto
ou Cartão de Crédito, porém nos pagamentos via Boleto, caso o dia do vencimento seja sábado
ou domingo (Final de semana), o mesmo pode ser pago no próximo dia útil.</p>
<blockquote>
<p><strong>IMPORTANTE</strong> Esta regra não está 100% correta ou eficiente, é apenas uma
demonstração</p>
</blockquote>
<pre><code class="language-csharp">public class Pagamento {
public bool PodeSerPago() {
if(tipo == ETipoPagamento.Boleto)
{
if(vencimento.Day != IsWeekend())
return true;
}
if(tipo == ETipoPagamento.CartaoCredito)
...
}
}
</code></pre>
<p>Note que temos duas tomadas de decisão dentro do método <strong>PodeSerPago</strong>, onde a
primeira se refere apenas a pagamentos do tipo Boleto. Caso hajam mais formas de pagamento
futuramente, como tratariamos este código? Encheriamos de <strong>IF</strong>?</p>
<p>A solução mais plausível é derivar da classe base <strong>Pagamento</strong> criando o
<strong>PagamentoBoleto</strong> que sobrescreve o método <strong>PodeSerPago</strong>,
dando uma nova funcionalidade a ele.
</p>
<pre><code class="language-csharp">public class Pagamento {
public virtual bool PodeSerPago() {
...
}
}
public class PagamentoBoleto : Pagamento {
public override bool PodeSerPago() {
if(vencimento.Day != IsWeekend())
return true;
}
}
</code></pre>
<h3 id="mult-thread">Mult-thread</h3>
<p>Sempre que necessário utilize processamento em Threads separadas. Já temos suporte a
multi-threads e paralelismo no C# faz um bom tempo e o próprio Async/Await já ajudam nisso.
</p>
<h4 id="exemplo-2">Exemplo</h4>
<p><small><strong>Sem async/await</strong></small></p>
<pre><code class="language-csharp">[HttpGet("cursos")]
public IActionResult Index([FromServices] IContentRepository repository)
{
ViewBag.Courses = repository.GetContents(EContentType.Course);
return View();
}
</code></pre>
<p><small><strong>Com async/await</strong></small></p>
<pre><code class="language-csharp">[HttpGet("cursos")]
public async Task<IActionResult> Index([FromServices] IContentRepository repository)
{
ViewBag.Courses = await repository.GetContentsAsync(EContentType.Course);
return View();
}
</code></pre>
<h3 id="separe-os-códigos-mult-thread">Separe os códigos mult-thread</h3>
<p>Seguindo o mesmo exemplo acima, é uma boa prática manter o que é assíncrono separado do que é
síncrono, para não forçar um método a ser ou não assíncrono por conta de outro trecho de
código.</p>
<h4 id="exemplo-3">Exemplo</h4>
<pre><code class="language-csharp">public async Task<IEnumerable<Model>> GetAsync()
{
var model = new Model();
model.Courses = await _context.Courses.ToListAsync();
model.Tags = _context.Courses.ToList(); // Não async
return model;
}
</code></pre>
<h3 id="utilize-async-como-sufixo">Utilize Async como sufixo</h3>
<p>Se um método é assíncrono, utilize sempre o sufixo <strong>async</strong> para identificá-lo.
</p>
<pre><code class="language-csharp">public async Task<IEnumerable<Model>> GetAsync()
</code></pre>
<h3 id="evite-configurações-desnecessárias">Evite configurações desnecessárias</h3>
<p>Evite deixar configurações no sistema só por que alguém ainda não definiu como aquilo deve
ser. Isto polui o código e traz uma complexidade desnecessária.</p>
<h4 id="exemplo-4">Exemplo</h4>
<pre><code class="language-csharp">public void ConfiguraUsoMySql()
{
// ainda não sabemos se vamos ou não suportar MySQL também
throw new NotImplementedException();
}
</code></pre>
<h3 id="utilize-injeção-de-dependência">Utilize injeção de dependência</h3>
<p>Sempre que possível utilize <a href="https://balta.io/blog/dependency-injection">injeção de
dependência</a>, ele vai tornar seu código mais limpo e desacoplado.</p>
<h4 id="exemplo-5">Exemplo</h4>
<p><a href="https://www.youtube.com/watch?v=va9wX68lAfA" title="Dependency Injection"><img
src="https://img.youtube.com/vi/va9wX68lAfA/0.jpg" alt="Dependency Injection" /></a>
</p>
<h3 id="lei-de-demeter">Lei de Demeter</h3>
<p>A Lei de Demeter (LoD) ou princípio do menor conhecimento é um princípio que prega os
seguintes pontos.</p>
<ul>
<li>Cada unidade deve ter conhecimento limitado sobre outras unidades: apenas unidades
próximas se relacionam.</li>
<li>Cada unidade deve apenas conversar com seus amigos.</li>
<li>Não fale com estranhos, apenas fale com seus amigos imediatos</li>
</ul>
<h4 id="exemplo-6">Exemplo</h4>
<pre><code class="language-csharp">public class Order()
{
public Discount Discount { get; set; }
}
public class Discount()
{
public decimal Amount { get; set; }
public void Apply() { ... }
}
</code></pre>
<p><small><strong>Mau exemplo</strong></small></p>
<pre><code class="language-csharp">public class OrderHandler()
{
var order = new Order();
order.Discount.Apply(); // <-
}
</code></pre>
<p><small><strong>Bom exemplo</strong></small></p>
<pre><code class="language-csharp">public class Order()
{
public Discount Discount { get; set; }
public void Place()
{
Discount?.Apply();
}
}
public class OrderHandler()
{
var order = new Order();
order.Place();
}
</code></pre>
<h2 id="regras-sobre-entendimento-do-código">Regras sobre entendimento do código</h2>
<h3 id="seja-consistente">Seja consistente</h3>
<p>Se você executa algo de uma forma, execute todo o resto desta mesma forma. Seja consistente
na forma com que aplica o código. Siga sempre o padrão definido.</p>
<h4 id="exemplo-7">Exemplo</h4>
<pre><code class="language-csharp">// Codificando em inglês
public class CustomerRepository { ... }
// Agora mudou para "portuglês"
public class ProdutoRepository { ... }
// Agora é português
public class RepositorioUnidadeMedida { ... }
</code></pre>
<pre><code class="language-csharp">// Utilizou sufixo ASYNC no método assíncrono
public async Task<Product> GetAsync() { ... }
// Agora não usou mais =/
public async Task<Course> Get() { ... }
</code></pre>
<h3 id="utilize-variáveis-concisas">Utilize variáveis concisas</h3>
<p>Opte por variáveis concisas, mesmo que resultem em um nome maior. Elas devem ser
auto-explicativas, sem a necessidade de comentários ou informações adicionais.</p>
<h4 id="exemplo-8">Exemplo</h4>
<pre><code class="language-csharp">// Total do que?
decimal total = 0;
// Total do carrinho de compras
decimal shoppingCartTotal = 0;
</code></pre>
<h3 id="obsessão-primitiva">Obsessão primitiva</h3>
<p>No dia-a-dia tendemos a nos focar apenas em tipos primitivos (Built-in), causando uma
obsessão pelos mesmos. Podemos criar e usar objetos de valor (Value Objects) para suprir
melhor esta necessidade.</p>
<h4 id="exemplo-9">Exemplo</h4>
<p><small><strong>Mau exemplo</strong></small></p>
<pre><code class="language-csharp">public class Customer
{
public string Email { get; set; }
public Customer
{
// Valida E-mail
}
}
public class Employee
{
public string Email { get; set; }
public Customer
{
// Valida E-mail novamente
}
}
</code></pre>
<p><small><strong>Bom exemplo</strong></small></p>
<pre><code class="language-csharp">// Value Object
public class Email
{
public string Address { get; set; }
public Email
{
// Valida E-mail
}
}
public class Customer
{
public Email Email { get; set; }
}
public class Employee
{
public Email Email { get; set; }
}
</code></pre>
<h3 id="evite-dependências-lógicas">Evite dependências lógicas</h3>
<p>Não escreva métodos cujo funcionamento correto dependa de algo contido em sua classe.</p>
<h4 id="exemplo-10">Exemplo</h4>
<p><small><strong>Mau exemplo</strong></small></p>
<pre><code class="language-csharp">public class Student
{
public bool IsSubscriber { get; set; }
public void Xpto()
{
if(IsSubscriber)
... // Só executa se for assinante
}
}
</code></pre>
<p><small><strong>Bom exemplo</strong></small></p>
<pre><code class="language-csharp">public class Student
{
...
}
public class Subscriber : Student
{
public void Xpto()
{
...
}
}
</code></pre>
<h3 id="evite-condicionais-negativas">Evite condicionais negativas</h3>
<p>No C# a negação é dada por um sinal de exclamação (<strong>!</strong>) que muitas vezes pode
ser imperceptível, ocasionando na má leitura do código.</p>
<h4 id="exemplo-11">Exemplo</h4>
<pre><code class="language-csharp">// Evite
if(!IsSubscriber) { ... }
// Utilize
if(IsSubscriber) { ... }
</code></pre>
<h2 id="regras-de-nomes">Regras de nomes</h2>
<h3 id="escolha-nomes-descritivos">Escolha nomes descritivos</h3>
<p>Esolher bons nomes para classes, variáveis e métodos é essencial para um código limpo.
Lembre-se que se você precisa explicar seu código, então algo pode ser melhorado nele.</p>
<h4 id="exemplo-12">Exemplo</h4>
<pre><code class="language-csharp">// Evite
var x = 256;
// Duração do que? Qual a métrica?
int duration = 25;
// Muito mais expressivo
int durationInMinutes = 25;
</code></pre>
<h3 id="faça-distinções-significantes">Faça distinções significantes</h3>
<p>Utilize sempre nomes nos quais quem estiver lendo seu código possa diferenciar seu
significado de outros possíveis nomes.</p>
<h4 id="exemplo-13">Exemplo</h4>
<pre><code class="language-csharp">// Evite
var salario = 7500M;
// Tem um significado maior
var salarioEmReais = 7500M;
</code></pre>
<h3 id="utilize-nomes-pronunciáveis-e-buscáveis">Utilize nomes pronunciáveis e buscáveis</h3>
<p>Evite utilizar nomes difíceis de pronunciar ou inventar nomes e conveções para variáveis,
classes e métodos. Lembre-se sempre da linguagem ubíquoa e da importância dela no código.
</p>
<h4 id="exemplo-14">Exemplo</h4>
<pre><code class="language-csharp">// Evite
var strTexto = "Meu texto aqui";
// Evite
public void GenerateBoletoInLote() {}
// Evite
public void Cadastry() {}
</code></pre>
<h3 id="evite-uso-excessivo-de-strings">Evite uso excessivo de strings</h3>
<p>Quem nunca perdeu horas procurando um BUG que era apenas um problema de comparação de string?
Evite digitar a mesma string várias vezes, utilize constantes para isto.</p>
<h4 id="exemplo-15">Exemplo</h4>
<pre><code class="language-csharp">// Evite
if(environment == "PROD")
...
// Utilize
const string ENV = "PROD";
if(environment == ENV)
...
</code></pre>
<h3 id="não-use-prefixo-ou-caracteres-especiais">Não use prefixo ou caracteres especiais</h3>
<p>Não utilize prefixo com o tipo da variável, classe ou método e NUNCA use espaços ou
caracteres especiais nestes itens.</p>
<h4 id="exemplo-16">Exemplo</h4>
<pre><code class="language-csharp">// Evite
public class clsCustomer { ... }
// Evite
string strNome = "André";
// Evite
var situação - "Pendente";
</code></pre>
<h2 id="regras-para-funções-ou-métodos">Regras para funções ou métodos</h2>
<h3 id="pequenas-e-com-apenas-um-objetivo">Pequenas e com apenas um objetivo</h3>
<p>Mantenha suas funções ou métodos o menor possível. É mais fácil ter métodos menores e
reutilizáveis do que tudo dentro de um método só.</p>
<h4 id="exemplo-17">Exemplo</h4>
<pre><code class="language-csharp">// Evite
public void RealizarPedido()
{
// Cadastra o cliente
// Aplica o desconto
// Atualiza o estoque
// Salva o pedido
}
// Utilize
public void SaveCustomer() { ... }
public void ApplyDiscount() { ... }
public void UpdateInventoy() { ... }
public void PlaceOrder() { ... }
</code></pre>
<h3 id="utilize-nomes-descritivos">Utilize nomes descritivos</h3>
<p>A mesma regra dos nomes anteriormente vista aqui se aplica para este cenário. Mantenha nomes
concisos, sem caracteres especiais.</p>
<h4 id="exemplo-18">Exemplo</h4>
<pre><code class="language-csharp">// Evite
// Calcular o que?
public void Calcular() { ... }
// Utilize
// Calcula o ICMS
public void CalcularICMS() { ... }
</code></pre>
<h3 id="opte-por-poucos-parâmetros">Opte por poucos parâmetros</h3>
<p>Evite exigir muitos parâmetros para construção do objeto, assim como use e abuse dos
<strong>Optional Parameters</strong> do C#.
</p>
<h4 id="exemplo-19">Exemplo</h4>
<pre><code class="language-csharp">// Evite
public void SaveCustomer(string street, string number, string neighborhood, string city, string state, string country, string zipCode) { ... }
// Melhorando
public void SaveCustomer(Address address) { ... }
</code></pre>
<h3 id="cuidado-com-efeitos-colaterais">Cuidado com efeitos colaterais</h3>
<p>Evite que uma função altere valores de outra classe sem ser a dela. Isto é chamado de efeito
colateral.</p>
<h4 id="exemplo-20">Exemplo</h4>
<pre><code class="language-csharp">// Evite
public class Order
{
public decimal Total { get; set; }
}
var order = new Order();
// Qualquer um fora da classe Order
// pode atualizar seu total
order.Total = 250;
</code></pre>
<pre><code class="language-csharp">// Utilize
public class Order
{
public decimal Total { get; private set; }
public void CalculateTotal() { ... }
}
var order = new Order();
// Total é privado, ninguém de fora consegue
// modificá-lo, evitando efeitos colaterais
order.Total = 250; // ERRO
</code></pre>
<h3 id="não-tome-decisões-desnecessárias">Não tome decisões desnecessárias</h3>
<p>Não utilize os famosos "flags" para tomar decisões dentro dos métodos, divida-os em
vários métodos ou até mesmo outras classes.</p>
<h4 id="exemplo-21">Exemplo</h4>
<pre><code class="language-csharp">// Evite
public class CustomerRepository
{
public void CreateOrUpdate(Customer customer, bool create)
{
if(create)
...
else
...
}
}
</code></pre>
<pre><code class="language-csharp">// Utilize
public class CustomerRepository
{
public void Create(Customer customer) { ... }
public void Update(Customer customer) { ... }
}
</code></pre>
<h2 id="regras-de-comentários">Regras de comentários</h2>
<h3 id="um-código-bom-é-expressivo">Um código bom é expressivo</h3>
<p>Teoricamente, se você precisa comentar uma parte do seu código, é por que algo está errado
com ele, ele não está expressivo o suficiente.</p>
<h3 id="não-seja-redundante">Não seja redundante</h3>
<p>Evite comentários que não fazem sentido algum ao contexto ou cenário.</p>
<h4 id="exemplo-22">Exemplo</h4>
<pre><code class="language-csharp">// Evite
// Função principal do sistema
public void Main() { ... }
</code></pre>
<h3 id="não-feche-os-comentários">Não feche os comentários</h3>
<p>Não há necessidade de fechar os comentários.</p>
<h4 id="exemplo-23">Exemplo</h4>
<pre><code class="language-csharp">// Evite
// Comentário // <- Desnecessário
public void Main() { ... }
</code></pre>
<h3 id="evite-códigos-comentados">Evite códigos comentados</h3>
<p>Não deixe sujeira em seu código, ao invés de deixar algo comentado, remova ele. Hoje temos
versionadores de código, você pode "voltar no tempo" facilmente.</p>
<h4 id="exemplo-24">Exemplo</h4>
<pre><code class="language-csharp">// Evite
public void MinhaFuncao()
{
// string texto = "1234";
// public void Metodo() {... }
}
</code></pre>
<h3 id="inteção">Inteção</h3>
<p>Um bom uso de comentários é sobre a intenção de um método, classe ou variável (Variável nem
tanto).</p>
<h4 id="exemplo-25">Exemplo</h4>
<pre><code class="language-csharp">// Utilize
// Retorna a lista de produtos inativos
// para o relatório de fechamento mensal
public IList<Product> ObtemProdutosInativos()
{
...
}
</code></pre>
<h3 id="esclarecimento">Esclarecimento</h3>
<p>Outro uso interessante para os comentários são esclarecimentos sobre o código.</p>
<h4 id="exemplo-26">Exemplo</h4>
<pre><code class="language-csharp">// Utilize
public void CancelarPedido()
{
// Caso o pedido já tenha sido enviado
// ele não pode mais ser cancelado.
if(DataEnvio > DateTime.Now)
{
AddNotification("O pedido já foi enviado e não pode ser cancelado");
}
}
</code></pre>
<h3 id="consequências">Consequências</h3>
<p>Podemos utilizar comentários para alertar sobre trechos do código que podem ter consequências
mais sérias. Neste caso recomendo o uso de um comentário em XML mais elaborado.</p>
<h4 id="exemplo-27">Exemplo</h4>
<pre><code class="language-csharp">// Utilize
/// <summary>
/// ATENÇÃO: Este método cancela o pedido e estorna o pagamento
/// </summary>
public void CancelarPedido()
{
...
}
</code></pre>
<h2 id="estrutura-do-código">Estrutura do código</h2>
<h3 id="separe-conceitos-verticalmente">Separe conceitos verticalmente</h3>
<p>Mantenha uma estrutura de pastas saudável e organizada. Não precisa criar uma pasta para cada
arquivo, mas pode haver uma separação por contexto ou feature.</p>
<h4 id="exemplo-28">Exemplo</h4>
<ul>
<li>MeuApp
<ul>
<li>MeuApp.Domain
<ul>
<li>MeuApp.Domain.Contexts
<ul>
<li>MeuApp.Domain.Contexts.PaymentContext
<ul>
<li>MeuApp.Domain.Contexts.PaymentContexts.Entities</li>
<li>MeuApp.Domain.Contexts.PaymentContexts.ValueObjects</li>
<li>MeuApp.Domain.Contexts.PaymentContexts.Enums</li>
</ul>
</li>
<li>MeuApp.Domain.Contexts.AccountContext
<ul>
<li>MeuApp.Domain.Contexts.AccountContext.Entities</li>
<li>MeuApp.Domain.Contexts.AccountContext.ValueObjects</li>
<li>MeuApp.Domain.Contexts.AccountContext.Enums</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h3 id="declare-variáveis-próximas-de-seu-uso">Declare variáveis próximas de seu uso</h3>
<p>Não crie todas as variáveis juntas, no começo da class ou método, defina-as próximas de onde
serão utilizadas.</p>
<h4 id="exemplo-29">Exemplo</h4>
<pre><code class="language-csharp">// Evite
var total = 0;
public void CreateCustomer() { ... }
public void CreateOrder() { ... }
public void UpdateCustomer() { ... }
public void CalculateTotal()
{
total = 250; // <- Só é utilizada aqui
}
</code></pre>
<pre><code class="language-csharp">// Utilize
public void CreateCustomer() { ... }
public void CreateOrder() { ... }
public void UpdateCustomer() { ... }
var total = 0;
public void CalculateTotal()
{
total = 250;
}
</code></pre>
<h3 id="agrupe-funcionalidades-similares">Agrupe funcionalidades similares</h3>
<p>Se uma função pertence a um grupo dentro de um objeto, mantenha-as sempre por perto.</p>
<h4 id="exemplo-30">Exemplo</h4>