forked from carlomilanesi/linguaggio-rust
-
Notifications
You must be signed in to change notification settings - Fork 0
/
documentation.html
1023 lines (872 loc) · 43.2 KB
/
documentation.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="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<title>Documentazione</title>
<link rel="stylesheet" type="text/css" href="rustbook.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<div id="nav">
<button id="toggle-nav">
<span class="sr-only">Toggle navigation</span>
<span class="bar"></span>
<span class="bar"></span>
<span class="bar"></span>
</button>
</div>
<div id='toc' class='mobile-hidden'>
<ul class='chapter'>
<li><a href='README.html'><b>1.</b> Introduzione</a>
</li>
<li><a href='getting-started.html'><b>2.</b> Come Iniziare</a>
</li>
<li><a href='guessing-game.html'><b>3.</b> Tutorial: Gioco-indovina</a>
</li>
<li><a href='syntax-and-semantics.html'><b>4.</b> Sintassi e semantica</a>
<ul class='section'>
<li><a href='variable-bindings.html'><b>4.1.</b> Legami di variabili</a>
</li>
<li><a href='functions.html'><b>4.2.</b> Funzioni</a>
</li>
<li><a href='primitive-types.html'><b>4.3.</b> Tipi primitivi</a>
</li>
<li><a href='comments.html'><b>4.4.</b> Commenti</a>
</li>
<li><a href='if.html'><b>4.5.</b> if</a>
</li>
<li><a href='loops.html'><b>4.6.</b> Cicli</a>
</li>
<li><a href='vectors.html'><b>4.7.</b> Vettori</a>
</li>
<li><a href='ownership.html'><b>4.8.</b> Possesso</a>
</li>
<li><a href='references-and-borrowing.html'><b>4.9.</b> Riferimenti e prestito</a>
</li>
<li><a href='lifetimes.html'><b>4.10.</b> Tempo di vita</a>
</li>
<li><a href='mutability.html'><b>4.11.</b> Mutabilità</a>
</li>
<li><a href='structs.html'><b>4.12.</b> Strutture</a>
</li>
<li><a href='enums.html'><b>4.13.</b> Enumerazioni</a>
</li>
<li><a href='match.html'><b>4.14.</b> Match</a>
</li>
<li><a href='patterns.html'><b>4.15.</b> Pattern</a>
</li>
<li><a href='method-syntax.html'><b>4.16.</b> Sintassi dei metodi</a>
</li>
<li><a href='strings.html'><b>4.17.</b> Stringhe</a>
</li>
<li><a href='generics.html'><b>4.18.</b> Genericità</a>
</li>
<li><a href='traits.html'><b>4.19.</b> Tratti</a>
</li>
<li><a href='drop.html'><b>4.20.</b> Drop</a>
</li>
<li><a href='if-let.html'><b>4.21.</b> `if let`</a>
</li>
<li><a href='trait-objects.html'><b>4.22.</b> Oggetti-tratti</a>
</li>
<li><a href='closures.html'><b>4.23.</b> Chiusure</a>
</li>
<li><a href='ufcs.html'><b>4.24.</b> Sintassi universale di chiamata di funzione</a>
</li>
<li><a href='crates-and-modules.html'><b>4.25.</b> Crate e moduli</a>
</li>
<li><a href='const-and-static.html'><b>4.26.</b> `const` e `static`</a>
</li>
<li><a href='attributes.html'><b>4.27.</b> Attributi</a>
</li>
<li><a href='type-aliases.html'><b>4.28.</b> Alias tramite `type`</a>
</li>
<li><a href='casting-between-types.html'><b>4.29.</b> Forzatura di tipo</a>
</li>
<li><a href='associated-types.html'><b>4.30.</b> Tipi associati</a>
</li>
<li><a href='unsized-types.html'><b>4.31.</b> Tipi non dimensionati</a>
</li>
<li><a href='operators-and-overloading.html'><b>4.32.</b> Operatori e sovraccaricamento</a>
</li>
<li><a href='deref-coercions.html'><b>4.33.</b> Coercizione Deref</a>
</li>
<li><a href='macros.html'><b>4.34.</b> Le macro</a>
</li>
<li><a href='raw-pointers.html'><b>4.35.</b> Puntatori grezzi</a>
</li>
<li><a href='unsafe.html'><b>4.36.</b> `unsafe`</a>
</li>
</ul>
</li>
<li><a href='effective-rust.html'><b>5.</b> Rust efficace</a>
<ul class='section'>
<li><a href='the-stack-and-the-heap.html'><b>5.1.</b> Lo stack e lo heap</a>
</li>
<li><a href='testing.html'><b>5.2.</b> Collaudo</a>
</li>
<li><a href='conditional-compilation.html'><b>5.3.</b> Compilazione condizionale</a>
</li>
<li><a class='active' href='documentation.html'><b>5.4.</b> Documentazione</a>
</li>
<li><a href='iterators.html'><b>5.5.</b> Iteratori</a>
</li>
<li><a href='concurrency.html'><b>5.6.</b> Concorrenza</a>
</li>
<li><a href='error-handling.html'><b>5.7.</b> Gestione degli errori</a>
</li>
<li><a href='choosing-your-guarantees.html'><b>5.8.</b> Scegliere le garanzie</a>
</li>
<li><a href='ffi.html'><b>5.9.</b> FFI</a>
</li>
<li><a href='borrow-and-asref.html'><b>5.10.</b> Prestito e AsRef</a>
</li>
<li><a href='release-channels.html'><b>5.11.</b> Canali di rilascio</a>
</li>
<li><a href='using-rust-without-the-standard-library.html'><b>5.12.</b> Usare Rust senza la libreria standard</a>
</li>
</ul>
</li>
<li><a href='nightly-rust.html'><b>6.</b> Rust notturno</a>
<ul class='section'>
<li><a href='compiler-plugins.html'><b>6.1.</b> Plugin del compilatore</a>
</li>
<li><a href='inline-assembly.html'><b>6.2.</b> Assembly in-line</a>
</li>
<li><a href='no-stdlib.html'><b>6.3.</b> Omettere la libreria stdandard</a>
</li>
<li><a href='intrinsics.html'><b>6.4.</b> Intrinseci</a>
</li>
<li><a href='lang-items.html'><b>6.5.</b> Elementi "lang"</a>
</li>
<li><a href='advanced-linking.html'><b>6.6.</b> Link avanzato</a>
</li>
<li><a href='benchmark-tests.html'><b>6.7.</b> Collaudi prestazionali</a>
</li>
<li><a href='box-syntax-and-patterns.html'><b>6.8.</b> Sintassi di box e relativi pattern</a>
</li>
<li><a href='slice-patterns.html'><b>6.9.</b> Pattern di slice</a>
</li>
<li><a href='associated-constants.html'><b>6.10.</b> Costanti associate</a>
</li>
<li><a href='custom-allocators.html'><b>6.11.</b> Allocatori personalizzati</a>
</li>
</ul>
</li>
<li><a href='glossary.html'><b>7.</b> Glossario</a>
</li>
<li><a href='syntax-index.html'><b>8.</b> Indice analitico della sintassi</a>
</li>
</ul>
</div>
<div id='page-wrapper'>
<div id='page'>
<h1 class="title">Documentazione</h1>
<p>La documentazione è una parte importante di qualunque progetto software, e
in Rust è di prima classe. Parliamo della strumentazione fornita da Rust
per documentare i propri progetti.</p>
<h2 id='a-proposito-di-rustdoc' class='section-header'><a href='#a-proposito-di-rustdoc'>A proposito di <code>rustdoc</code></a></h2>
<p>La distribuzione di Rust include uno strumento, <code>rustdoc</code>, che genera
documentazione. <code>rustdoc</code> viene usato anche da Cargo con il comando
<code>cargo doc</code>.</p>
<p>La documentazione può essere generata in due modi: dal codice sorgente,
e da file Markdown autonomi.</p>
<h2 id='documentare-il-codice-sorgente' class='section-header'><a href='#documentare-il-codice-sorgente'>Documentare il codice sorgente</a></h2>
<p>Il modo primario di documentare un progetto Rust è annotando il codice
sorgente. A questo scopo, si possono usare i commenti di documentazione:</p>
<span class='rusttest'>fn main() {
/// Costruisce un nuovo `Rc<T>`.
///
/// # Esempi
///
/// ```
/// use std::rc::Rc;
///
/// let cinque = Rc::new(5);
/// ```
pub fn new(value: T) -> Rc<T> {
// l'implementazione va qui
}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// Costruisce un nuovo `Rc<T>`.</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// # Esempi</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// use std::rc::Rc;</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// let cinque = Rc::new(5);</span>
<span class='doccomment'>/// ```</span>
<span class='kw'>pub</span> <span class='kw'>fn</span> <span class='ident'>new</span>(<span class='ident'>value</span>: <span class='ident'>T</span>) <span class='op'>-></span> <span class='ident'>Rc</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> {
<span class='comment'>// l'implementazione va qui</span>
}</pre>
<p>Questo codice genera della documentazione che si presenta <a href="../std/rc/struct.Rc.html#method.new">così</a>.
Ho escluso l'implementazione, mettendo al suo posto un normale commento.</p>
<p>La prima cosa da notare riguardo a questa annotazione è che usa
<code>///</code> invece di <code>//</code>. La tripla barra indica un commento di documentazione.</p>
<p>I commenti di documentazione sono scritti in Markdown.</p>
<p>Rust tiene traccia di questi commenti, e li usa quando genera
la documentazione. Questo è importante quando si documentano cose come
gli enums:</p>
<span class='rusttest'>fn main() {
/// Il tipo `Option`. Si veda
// [la documentazione a livello di modulo](index.html) per saperne di più.
enum Option<T> {
/// Nessun valore
None,
/// Qualche valore `T`
Some(T),
}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// Il tipo `Option`. Si veda</span>
<span class='comment'>// [la documentazione a livello di modulo](index.html) per saperne di più.</span>
<span class='kw'>enum</span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> {
<span class='doccomment'>/// Nessun valore</span>
<span class='prelude-val'>None</span>,
<span class='doccomment'>/// Qualche valore `T`</span>
<span class='prelude-val'>Some</span>(<span class='ident'>T</span>),
}</pre>
<p>Il codice sopra funziona, ma questo sotto no:</p>
<span class='rusttest'>fn main() {
/// Il tipo `Option`. Si veda
// [la documentazione a livello di modulo](index.html) per saperne di più.
enum Option<T> {
None, /// Nessun valore
Some(T), /// Qualche valore `T`
}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// Il tipo `Option`. Si veda</span>
<span class='comment'>// [la documentazione a livello di modulo](index.html) per saperne di più.</span>
<span class='kw'>enum</span> <span class='prelude-ty'>Option</span><span class='op'><</span><span class='ident'>T</span><span class='op'>></span> {
<span class='prelude-val'>None</span>, <span class='doccomment'>/// Nessun valore</span>
<span class='prelude-val'>Some</span>(<span class='ident'>T</span>), <span class='doccomment'>/// Qualche valore `T`</span>
}</pre>
<p>Infatti si avrà l'errore:</p>
<pre><code class="language-text">hello.rs:4:1: 4:2 error: expected ident, found `}`
hello.rs:4 }
^
</code></pre>
<p>Questo <a href="https://github.com/rust-lang/rust/issues/22547">errore sfortunato</a> è
giusto; i commenti di documentazione si applicano a quello che li segue,
e non c'è niente dopo l'ultimo commento.</p>
<h3 id='scrivere-i-commenti-di-documentazione' class='section-header'><a href='#scrivere-i-commenti-di-documentazione'>Scrivere i commenti di documentazione</a></h3>
<p>Comunque, vediamo in dettaglio ogni parte di questo commento:</p>
<span class='rusttest'>fn main() {
/// Costruisce un nuovo `Rc<T>`.
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// Costruisce un nuovo `Rc<T>`.</span></pre>
<p>La prima riga di un commento di documentazione dovrebbe essere un breve
riassunto della sua funzionalità che sta descrivendo. Una sola frase.
Solo le basi. Ad alto livello.</p>
<span class='rusttest'>fn main() {
///
/// Altri dettagli sulla costruzione degli `Rc<T>`, eventualmente descrivendo
/// una semantica complicata, forse anche delle opzioni aggiuntive,
/// tutti gli aspetti
///
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>///</span>
<span class='doccomment'>/// Altri dettagli sulla costruzione degli `Rc<T>`, eventualmente descrivendo</span>
<span class='doccomment'>/// una semantica complicata, forse anche delle opzioni aggiuntive,</span>
<span class='doccomment'>/// tutti gli aspetti</span>
<span class='doccomment'>///</span></pre>
<p>Il nostro esempio originale aveva solo una riga riassuntiva, ma se avessimo
avuto più cose da dire, avremmo potuto aggiungere altre spiegazioni
in un altro paragrafo.</p>
<h4 id='sezioni-speciali' class='section-header'><a href='#sezioni-speciali'>Sezioni speciali</a></h4>
<p>Poi, ci sono le sezioni speciali. Queste sono indicate con un'intestazione,
<code>#</code>. Ci sono quattro tipi di intestazioni che vengono comunemente usate.
Per adesso, non hanno una sintassi speciale, ma solo convenzioni.</p>
<span class='rusttest'>fn main() {
/// # Panico
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// # Panico</span></pre>
<p>L'abuso irrecuperabile di una funzione (cioè un errore di programmazione)
in Rust è solitamente chiamato panico, che come minimo uccide l'intero thread
corrente. Se la propria funzione ha un contratto non banale, che se
rilevato/forzato produce un panico, è molto importante documentarlo.</p>
<span class='rusttest'>fn main() {
/// # Errori
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// # Errori</span></pre>
<p>Se la propria funzion o il proprio metodo rene un <code>Result<T, E></code>, allora
descrivere le condizioni sotto le quali restituisce <code>Err(E)</code> è una cosa carina
da fare. Questo è leggermento meno importante del <code>Panics</code>,
perché tale fallimento è codificato nel sistema dei tipi,
ma è sempre una buona cosa da fare.</p>
<span class='rusttest'>fn main() {
/// # Sicurezza
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// # Sicurezza</span></pre>
<p>Se la propria funzione è <code>unsafe</code>, si dovrebbe spiegare quali invarianti
il chiamante è tenuto a rispettare.</p>
<span class='rusttest'>fn main() {
/// # Esempi
///
/// ```
/// use std::rc::Rc;
///
/// let cinque = Rc::new(5);
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// # Esempi</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// use std::rc::Rc;</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// let cinque = Rc::new(5);</span>
<span class='doccomment'>/// ```</span></pre>
<p>Quarto, <code>Esempi</code>. Aggiungere uno o più esempi di come usare la propria
funzione, sarà molto apprezzato dagli utenti di tale funzione. Questi esempi
vanno dentro annotazioni di blocchi di codice, di cui parleremo fra un momento,
e possono avere più di una sezione:</p>
<span class='rusttest'>fn main() {
/// # Esempi
///
/// Semplici pattern di `&str`:
///
/// ```
/// let v: Vec<&str> = "Mary had a little lamb".split(' ').collect();
/// assert_eq!(v, vec!["Mary", "had", "a", "little", "lamb"]);
/// ```
///
/// Pattern più complessi, con una lambda:
///
/// ```
/// let v: Vec<&str> = "abc1def2ghi".split(|c: char| c.is_numeric()).collect();
/// assert_eq!(v, vec!["abc", "def", "ghi"]);
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// # Esempi</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// Semplici pattern di `&str`:</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// let v: Vec<&str> = "Mary had a little lamb".split(' ').collect();</span>
<span class='doccomment'>/// assert_eq!(v, vec!["Mary", "had", "a", "little", "lamb"]);</span>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// Pattern più complessi, con una lambda:</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// let v: Vec<&str> = "abc1def2ghi".split(|c: char| c.is_numeric()).collect();</span>
<span class='doccomment'>/// assert_eq!(v, vec!["abc", "def", "ghi"]);</span>
<span class='doccomment'>/// ```</span></pre>
<p>Discutiamo i dettagli di questi blocchi di codice.</p>
<h4 id='annotazioni-dei-blocchi-di-codice' class='section-header'><a href='#annotazioni-dei-blocchi-di-codice'>Annotazioni dei blocchi di codice</a></h4>
<p>Per scrivere del codice Rust dentro un commento, si usa
il triplo accento grave:</p>
<span class='rusttest'>fn main() {
/// ```
/// println!("Ciao, mondo");
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// println!("Ciao, mondo");</span>
<span class='doccomment'>/// ```</span></pre>
<p>Se si vuol scrivere qualcosa che non è codice Rust, si può aggiungere
un'annotazione:</p>
<span class='rusttest'>fn main() {
/// ```c
/// printf("Ciao, mondo\n");
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// ```c</span>
<span class='doccomment'>/// printf("Ciao, mondo\n");</span>
<span class='doccomment'>/// ```</span></pre>
<p>Questo evidenzierà la sintassi del codice in base al linguaggio indicato.
Se si sta mostrando del semplice testo, si scelga <code>text</code>.</p>
<p>Qui è importante scegliere l'annotazione corretta, perché <code>rustdoc</code> la usa
in un modo interessante: può venire usata per collaudare effettivamente
gli esempi in un crate di libreria, così da assicurasi che rimangano
aggiornati. Se si ha del codice C ma <code>rustdoc</code> pensa che sia Rust perché non
si è aggiunta l'annotazione, <code>rustdoc</code> si lamenterà quando proverà a generare
la documentazione.</p>
<h2 id='documentazione-come-test' class='section-header'><a href='#documentazione-come-test'>Documentazione come test</a></h2>
<p>Discutiamo il nostro esempio di documentazione:</p>
<span class='rusttest'>fn main() {
/// ```
/// println!("Ciao, mondo");
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// println!("Ciao, mondo");</span>
<span class='doccomment'>/// ```</span></pre>
<p>Si noterà che qui non c'è bisogno di un <code>fn main()</code> né di altro. <code>rustdoc</code>
aggiungerà automaticamente una funzione <code>main()</code> intorno al nostro codice,
usando dell'euristica per tentare di metterlo al posto giusto. Per esempio:</p>
<span class='rusttest'>fn main() {
/// ```
/// use std::rc::Rc;
///
/// let cinque = Rc::new(5);
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// use std::rc::Rc;</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// let cinque = Rc::new(5);</span>
<span class='doccomment'>/// ```</span></pre>
<p>Questo finirà per collaudare:</p>
<span class='rusttest'>fn main() {
use std::rc::Rc;
let cinque = Rc::new(5);
}
</span><pre class='rust rust-example-rendered'>
<span class='kw'>fn</span> <span class='ident'>main</span>() {
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>rc</span>::<span class='ident'>Rc</span>;
<span class='kw'>let</span> <span class='ident'>cinque</span> <span class='op'>=</span> <span class='ident'>Rc</span>::<span class='ident'>new</span>(<span class='number'>5</span>);
}</pre>
<p>Ecco l'algoritmo completo che rustdoc usa per preprocessare gli esempi:</p>
<ol>
<li>Tutti gli attributi iniziali <code>#![foo]</code> sono lasciati intatt come
attributi del crate.</li>
<li>Alcuni attributi <code>allow</code> tipici vengono inseriti, tra cui
<code>unused_variables</code>, <code>unused_assignments</code>, <code>unused_mut</code>, <code>unused_attributes</code>,
e <code>dead_code</code>. Dei piccoli esempi spesso fanno scattare questi lint.</li>
<li>Se l'esempio non contiene <code>extern crate</code>, allora <code>extern crate <mycrate>;</code> viene inserito (si noti l'assenza di <code>#[macro_use]</code>).</li>
<li>Infine, se l'esempio non contiene <code>fn main</code>, il resto del testo è
avvolto in <code>fn main() { il_nostro_codice }</code>.</li>
</ol>
<p>Però questo <code>fn main</code> generato può creare problemi! Se ci sono istruzioni
<code>extern crate</code> o <code>mod</code> nel codice d'esempio, che sono riferite da istruzioni
<code>use</code>, non potranno essere risolte a meno che si includa almeno <code>fn main() {}</code>
per inibire il passo 4. Anche l'istruzione <code>#[macro_use] extern crate</code>
non funziona eccetto che alla radice del crate, e quindi, quando si collaudano
delle macro, è sempre obbligatorio inserire un <code>main</code> esplicito. Però,
non deve ingombrare la documentazione -- andiamo avanti a leggere!</p>
<p>Però, talvolta questo algoritmo non basta. Per esempio, che dire di tutti
questi esempi di codice con <code>///</code> di cui abbiamo parlato? Il testo grezzo:</p>
<pre><code class="language-text">/// Un po' di documentazione.
# fn foo() {}
</code></pre>
<p>appare diverso dall'output:</p>
<span class='rusttest'>fn main() {
/// Un po' di documentazione.
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// Un po' di documentazione.</span></pre>
<p>Sì, è giusto: si possono aggiungere righe che iniziano con <code>#</code>, e verranno
nascoste dall'output, ma verranno usate quando si compila il proprio codice.
Lo si può usare a proprio vantaggio. In questo caso, i commenti
di documentazione devono essere applicati a qualche tipo di funzione, e quindi
se voglio mostrare appena un commento di documentazione, devo aggiungere
una piccola definizione di funzione sotto di esso. Al medesimo tempo, è lì
solamente per soddisfare il compilatore, e quindi nasconderla rende l'esempio
più chiaro. Si può usare questa tecnica per spiegare in dettaglio esempi
più lunghi, pur conservando la collaudabilità della propria documentazione.</p>
<p>Per esempio, si imagini che volessimo documentare questo codice:</p>
<span class='rusttest'>fn main() {
let x = 5;
let y = 6;
println!("{}", x + y);
}</span><pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>x</span> <span class='op'>=</span> <span class='number'>5</span>;
<span class='kw'>let</span> <span class='ident'>y</span> <span class='op'>=</span> <span class='number'>6</span>;
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"{}"</span>, <span class='ident'>x</span> <span class='op'>+</span> <span class='ident'>y</span>);</pre>
<p>Potremmo volere che la documentazione finisca per apparire così:</p>
<blockquote>
<p>Prima, impostiamo <code>x</code> a cinque:</p>
<span class='rusttest'>fn main() {
let x = 5;
let y = 6;
println!("{}", x + y);
}</span><pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>x</span> <span class='op'>=</span> <span class='number'>5</span>;</pre>
<p>Poi, impostiamo <code>y</code> a sei:</p>
<span class='rusttest'>fn main() {
let x = 5;
let y = 6;
println!("{}", x + y);
}</span><pre class='rust rust-example-rendered'>
<span class='kw'>let</span> <span class='ident'>y</span> <span class='op'>=</span> <span class='number'>6</span>;</pre>
<p>E infine, stampiamo la somma di <code>x</code> e <code>y</code>:</p>
<span class='rusttest'>fn main() {
let x = 5;
let y = 6;
println!("{}", x + y);
}</span><pre class='rust rust-example-rendered'>
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"{}"</span>, <span class='ident'>x</span> <span class='op'>+</span> <span class='ident'>y</span>);</pre>
</blockquote>
<p>Per mantenere collaudabile ogni blocco di codice, vogliamo l'intero programma
in ogni blocco, ma non vogliamo che il lettore veda tutte le linee ogni volta.
Ecco cosa abbiamo messo nel nostro codice sorgente:</p>
<pre><code class="language-text"> Prima, impostiamo `x` a cinque:
```rust
let x = 5;
# let y = 6;
# println!("{}", x + y);
```
Poi, impostiamo `y` a sei:
```rust
# let x = 5;
let y = 6;
# println!("{}", x + y);
```
E infine, stampiamo la somma di `x` e `y`:
```rust
# let x = 5;
# let y = 6;
println!("{}", x + y);
```
</code></pre>
<p>Ripetendo tutte le parti dell'esempio, possiamo assicurarci che
il nostro esempio compili ancora, mentre mostriamo solamente le parti che
sono rilevanti a quella parte della nostra spiegazione.</p>
<h3 id='macro-di-documentazione' class='section-header'><a href='#macro-di-documentazione'>Macro di documentazione</a></h3>
<p>Ecco un esempio di come si documenta una macro:</p>
<span class='rusttest'>/// Va in panico con un dato messaggio, a meno che un'espressione valga true.
///
/// # Esempi
///
/// ```
/// # #[macro_use] extern crate foo;
/// # fn main() {
/// panic_unless!(1 + 1 == 2, “La matematica è scassata.”);
/// # }
/// ```
///
/// ```rust,should_panic
/// # #[macro_use] extern crate foo;
/// # fn main() {
/// panic_unless!(true == false, “Sono scassato.”);
/// # }
/// ```
#[macro_export]
macro_rules! panic_unless {
($condition:expr, $($rest:expr),+) => ({ if ! $condition { panic!($($rest),+); } });
}
fn main() {}
</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// Va in panico con un dato messaggio, a meno che un'espressione valga true.</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// # Esempi</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// # #[macro_use] extern crate foo;</span>
<span class='doccomment'>/// # fn main() {</span>
<span class='doccomment'>/// panic_unless!(1 + 1 == 2, “La matematica è scassata.”);</span>
<span class='doccomment'>/// # }</span>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// ```rust,should_panic</span>
<span class='doccomment'>/// # #[macro_use] extern crate foo;</span>
<span class='doccomment'>/// # fn main() {</span>
<span class='doccomment'>/// panic_unless!(true == false, “Sono scassato.”);</span>
<span class='doccomment'>/// # }</span>
<span class='doccomment'>/// ```</span>
<span class='attribute'>#[<span class='ident'>macro_export</span>]</span>
<span class='macro'>macro_rules</span><span class='macro'>!</span> <span class='ident'>panic_unless</span> {
(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>condition</span>:<span class='ident'>expr</span>, $(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>rest</span>:<span class='ident'>expr</span>),<span class='op'>+</span>) <span class='op'>=></span> ({ <span class='kw'>if</span> <span class='op'>!</span> <span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>condition</span> { <span class='macro'>panic</span><span class='macro'>!</span>($(<span class='macro-nonterminal'>$</span><span class='macro-nonterminal'>rest</span>),<span class='op'>+</span>); } });
}</pre>
<p>Si noteranno tre cose: dobbiamo aggiungere la nostra riga <code>extern crate</code>, per
poter aggiungere l'attributo <code>#[macro_use]</code>. Secondo, dovremo aggiungere anche
la nostra <code>main()</code> (per la ragione detta prima). Infine, un uso giudizioso
di <code>#</code> per escludere quelle due cose, così che non appaiano nell'output.</p>
<p>Un altro caso dove l'suo di <code>#</code> è comodo è quando si vuole ignorare
la gestione degli errori. Diciamo che vogliamo il codice seguente,</p>
<span class='rusttest'>fn main() {
/// use std::io;
/// let mut input = String::new();
/// try!(io::stdin().read_line(&mut input));
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// use std::io;</span>
<span class='doccomment'>/// let mut input = String::new();</span>
<span class='doccomment'>/// try!(io::stdin().read_line(&mut input));</span></pre>
<p>Il problema è che <code>try!</code> restituisce un <code>Result<T, E></code>, e dato che le funzioni
di test non devono restituire niente, questo codice genererà un errore di tipo.</p>
<span class='rusttest'>fn main() {
/// Un test di documentazione che usa "try!"
///
/// ```
/// use std::io;
/// # fn foo() -> io::Result<()> {
/// let mut input = String::new();
/// try!(io::stdin().read_line(&mut input));
/// # Ok(())
/// # }
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// Un test di documentazione che usa "try!"</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// use std::io;</span>
<span class='doccomment'>/// # fn foo() -> io::Result<()> {</span>
<span class='doccomment'>/// let mut input = String::new();</span>
<span class='doccomment'>/// try!(io::stdin().read_line(&mut input));</span>
<span class='doccomment'>/// # Ok(())</span>
<span class='doccomment'>/// # }</span>
<span class='doccomment'>/// ```</span></pre>
<p>Questo problema si può aggirare avvolgendo il codice in una funzione.
Questa prende e inghiotte il <code>Result<T, E></code> quando si eseguono i test
sui documenti. Questo pattern appare regolarmente nella libreria standard.</p>
<h3 id='eseguire-i-test-della-documentazione' class='section-header'><a href='#eseguire-i-test-della-documentazione'>Eseguire i test della documentazione</a></h3>
<p>Per eseguire i test, o si esegue:</p>
<pre><code class="language-bash">$ rustdoc --test percorso/al/mio/crate/radice.rs
# oppure si esegue
$ cargo test
</code></pre>
<p>Proprio così, <code>cargo test</code> collauda anche la documentazione incorporata
nei sorgenti. <strong>Però, <code>cargo test</code> non collauderà i crate di programma, ma
solamente quelli di libreria.</strong> Questo è dovuto al modo in cui funziona
<code>rustdoc</code>: esegue il link con la libreria da collaudare, ma con un programma,
non c'è niente con cui eseguire il link.</p>
<p>Ci sono alcune altre annotazione che servono ad aiutare <code>rustdoc</code> a fare
la cosa giusta quando collauda il codice:</p>
<span class='rusttest'>fn main() {
/// ```rust,ignore
/// fn foo() {
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// ```rust,ignore</span>
<span class='doccomment'>/// fn foo() {</span>
<span class='doccomment'>/// ```</span></pre>
<p>La direttiva <code>ignore</code> dice a Rust di ignorare il codice. Questo non è
quasi mai quello che si vuole, dato che è il più generico. Invece, si prenda
in considerazione l'annotarlo con <code>text</code> se non è codice, o l'usare i <code>#</code> per
ottenere un esempio funzionante che mostra solamente la parte che interessa.</p>
<span class='rusttest'>fn main() {
/// ```rust,should_panic
/// assert!(false);
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// ```rust,should_panic</span>
<span class='doccomment'>/// assert!(false);</span>
<span class='doccomment'>/// ```</span></pre>
<p><code>should_panic</code> dice a <code>rustdoc</code> che il codice dovrebbe compilare correttamente,
ma non passare effettivamente come test.</p>
<span class='rusttest'>fn main() {
/// ```rust,no_run
/// loop {
/// println!("Hello, world");
/// }
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// ```rust,no_run</span>
<span class='doccomment'>/// loop {</span>
<span class='doccomment'>/// println!("Hello, world");</span>
<span class='doccomment'>/// }</span>
<span class='doccomment'>/// ```</span></pre>
<p>L'attributo <code>no_run</code> compilerà il codice, ma non lo eseguirà. Questo è
importante per gli esempi come "Ecco come avviare un servizio di rete," che si
vorrebbe assicurarsi che compili, ma che potrebbe eseguire un ciclo infinito!</p>
<h3 id='documentare-i-moduli' class='section-header'><a href='#documentare-i-moduli'>Documentare i moduli</a></h3>
<p>Rust ha un altro tipo di commento di documentazione, <code>//!</code>. Questo commento
non documenta l'elemento successivo, ma quello che lo racchiude. In altre
parole:</p>
<span class='rusttest'>fn main() {
mod foo {
//! Questa è documentazione per il modulo `foo`.
//!
//! # Esempi
// ...
}
}</span><pre class='rust rust-example-rendered'>
<span class='kw'>mod</span> <span class='ident'>foo</span> {
<span class='doccomment'>//! Questa è documentazione per il modulo `foo`.</span>
<span class='doccomment'>//!</span>
<span class='doccomment'>//! # Esempi</span>
<span class='comment'>// ...</span>
}</pre>
<p>Qui è dove si vedrà <code>//!</code> usato più spesso: per la documentazione dei moduli.
Se si ha un modulo in <code>foo.rs</code>, spesso, quando si apre il suo codice, si vedrà:</p>
<span class='rusttest'>fn main() {
//! Un modulo per usare i `foo`.
//!
//! Il modulo `foo` contiene molte funzionalità utili, bla bla bla ...
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>//! Un modulo per usare i `foo`.</span>
<span class='doccomment'>//!</span>
<span class='doccomment'>//! Il modulo `foo` contiene molte funzionalità utili, bla bla bla ...</span></pre>
<h3 id='documentazione-dei-crate' class='section-header'><a href='#documentazione-dei-crate'>Documentazione dei crate</a></h3>
<p>I crate possono essere documentati collocando un commento interno
di documentazione (<code>//!</code>) all'inizio della radice del crate, ossia di <code>lib.rs</code>:</p>
<span class='rusttest'>fn main() {
//! Questa è documentazione per il crate `foo`.
//!
//! Il crate `foo` è pensato per essere usate per `bar`.
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>//! Questa è documentazione per il crate `foo`.</span>
<span class='doccomment'>//!</span>
<span class='doccomment'>//! Il crate `foo` è pensato per essere usate per `bar`.</span></pre>
<h3 id='stile-dei-commenti-di-documentazione' class='section-header'><a href='#stile-dei-commenti-di-documentazione'>Stile dei commenti di documentazione</a></h3>
<p>Si veda la <a href="https://github.com/rust-lang/rfcs/blob/master/text/0505-api-comment-conventions.md">RFC 505</a> per le convezioni complete sullo stile
e il formato della documentazione.</p>
<h2 id='altra-documentazione' class='section-header'><a href='#altra-documentazione'>Altra documentazione</a></h2>
<p>Tutto questo comportamento funziona anche in file sorgente non in Rust.
Siccome i commenti sono scritti in Markdown, sono spesso dei file <code>.md</code>.</p>
<p>Quando si scrive della documentazione nei file Markdown, non serve marcare
la documentazione con i prefissi dei commenti. Per esempio:</p>
<span class='rusttest'>fn main() {
/// # Esempi
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
/// ```
fn foo() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// # Esempi</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// ```</span>
<span class='doccomment'>/// use std::rc::Rc;</span>
<span class='doccomment'>///</span>
<span class='doccomment'>/// let five = Rc::new(5);</span>
<span class='doccomment'>/// ```</span></pre>
<p>è:</p>
<pre><code class="language-markdown"># Esempi
```
use std::rc::Rc;
let five = Rc::new(5);
```
</code></pre>
<p>quando è in un file Markdown. Però c'è un neo: i file Markdown devono avere
un titolo così:</p>
<pre><code class="language-markdown">% Il titolo
Questa è la documentazione d'esempio.
</code></pre>
<p>Questa riga che inizia con <code>%</code> deve essere la primissima riga del file.</p>
<h2 id='attributi-doc' class='section-header'><a href='#attributi-doc'>Attributi <code>doc</code></a></h2>
<p>A un livello più profondo, i commenti di documentazione sono addolcimento
sintattico per gli attributi di documentazione:</p>
<span class='rusttest'>fn main() {
/// questo
fn foo() {}
#[doc="questo"]
fn bar() {}
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>/// questo</span>
<span class='attribute'>#[<span class='ident'>doc</span><span class='op'>=</span><span class='string'>"questo"</span>]</span></pre>
<p>sono equivalenti, così come lo sono questi:</p>
<span class='rusttest'>fn main() {
//! questo
#![doc="questo"]
}</span><pre class='rust rust-example-rendered'>
<span class='doccomment'>//! questo</span>
<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>doc</span><span class='op'>=</span><span class='string'>"questo"</span>]</span></pre>
<p>Non si vedrà spesso questo attributo usato per scrivere documentazione, ma può
essere utile quando si cambiamo alcune opzioni, o quando si scrive una macro.</p>
<h3 id='ri-esportazioni' class='section-header'><a href='#ri-esportazioni'>Ri-esportazioni</a></h3>
<p><code>rustdoc</code> mostrerà la documentazione per una ri-esportazione pubblica
in entrambi i posti:</p>
<span class='rusttest'>fn main() {
extern crate foo;
pub use foo::bar;
}</span><pre class='rust rust-example-rendered'>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>foo</span>;
<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>foo</span>::<span class='ident'>bar</span>;</pre>
<p>Questo creerà la documentazione per <code>bar</code> sia dentro la documentazione
del crate <code>foo</code>, che nella documentazione del crate corrente. Userà la medesima
documentazione in entrambi i posti.</p>
<p>Questo comportamento può venire soppresso usando <code>no_inline</code>:</p>
<span class='rusttest'>fn main() {
extern crate foo;
#[doc(no_inline)]
pub use foo::bar;
}</span><pre class='rust rust-example-rendered'>
<span class='kw'>extern</span> <span class='kw'>crate</span> <span class='ident'>foo</span>;
<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>no_inline</span>)]</span>
<span class='kw'>pub</span> <span class='kw'>use</span> <span class='ident'>foo</span>::<span class='ident'>bar</span>;</pre>
<h2 id='documentazione-mancante' class='section-header'><a href='#documentazione-mancante'>Documentazione mancante</a></h2>
<p>Talvolta ci si vuole assicurare che ogni singola cosa public nel proprio
progetto sia documentata, specialmente quando si sta lavorando a una libreria.
Rust consente di generare avvertimenti o errori, quando un elemento è privo
di documentazione. Per generare degli avvertimenti, si usa <code>warn</code>:</p>
<span class='rusttest'>fn main() {
#![warn(missing_docs)]
}</span><pre class='rust rust-example-rendered'>
<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>warn</span>(<span class='ident'>missing_docs</span>)]</span></pre>
<p>E per generare errore si usa <code>deny</code>:</p>
<span class='rusttest'>fn main() {
#![deny(missing_docs)]
}</span><pre class='rust rust-example-rendered'>
<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>deny</span>(<span class='ident'>missing_docs</span>)]</span></pre>
<p>Ci sono casi in cui si vogliono disabilitare questi avvertimenti/errori
per lasciare esplicitamente qualcosa di non documentato. Questo si fa
usando <code>allow</code>:</p>
<span class='rusttest'>fn main() {
#[allow(missing_docs)]
struct NonDocumentata;
}</span><pre class='rust rust-example-rendered'>
<span class='attribute'>#[<span class='ident'>allow</span>(<span class='ident'>missing_docs</span>)]</span>
<span class='kw'>struct</span> <span class='ident'>NonDocumentata</span>;</pre>
<p>Si potrebbe perfino voler nascondere completamente degli elementi
dalla documentazione:</p>
<span class='rusttest'>fn main() {
#[doc(hidden)]
struct Nascosta;
}</span><pre class='rust rust-example-rendered'>
<span class='attribute'>#[<span class='ident'>doc</span>(<span class='ident'>hidden</span>)]</span>
<span class='kw'>struct</span> <span class='ident'>Nascosta</span>;</pre>
<h3 id='controllare-lhtml' class='section-header'><a href='#controllare-lhtml'>Controllare l'HTML</a></h3>
<p>Si possono controllare alcuni aspetti del codice HTML generato da <code>rustdoc</code>,
tramite la versione <code>#![doc]</code> dell'attributo:</p>
<span class='rusttest'>fn main() {
#![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
html_favicon_url = "https://www.rust-lang.org/favicon.ico",
html_root_url = "https://doc.rust-lang.org/")]
}</span><pre class='rust rust-example-rendered'>
<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>doc</span>(<span class='ident'>html_logo_url</span> <span class='op'>=</span> <span class='string'>"https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png"</span>,
<span class='ident'>html_favicon_url</span> <span class='op'>=</span> <span class='string'>"https://www.rust-lang.org/favicon.ico"</span>,
<span class='ident'>html_root_url</span> <span class='op'>=</span> <span class='string'>"https://doc.rust-lang.org/"</span>)]</span></pre>
<p>Quest imposta alcune diverse opzioni, con un logo, un'icona per i preferiti
(favicon), e un URL radice.</p>
<h3 id='configurare-il-collaudo-della-documentazione' class='section-header'><a href='#configurare-il-collaudo-della-documentazione'>Configurare il collaudo della documentazione</a></h3>
<p>Si può anche configurare il modo in cui <code>rustdoc</code> collauda gli esempi
nella documentazione tramite l'attributo <code>#![doc(test(..))]</code>.</p>
<span class='rusttest'>fn main() {
#![doc(test(attr(allow(unused_variables), deny(warnings))))]
}</span><pre class='rust rust-example-rendered'>
<span class='attribute'>#<span class='op'>!</span>[<span class='ident'>doc</span>(<span class='ident'>test</span>(<span class='ident'>attr</span>(<span class='ident'>allow</span>(<span class='ident'>unused_variables</span>), <span class='ident'>deny</span>(<span class='ident'>warnings</span>))))]</span></pre>
<p>Ciò consente che gli esempi contengano variabili inutilizzate, ma fallirà
il test per ogni altro avvertimento generato.</p>
<h2 id='opzioni-di-generazione' class='section-header'><a href='#opzioni-di-generazione'>Opzioni di generazione</a></h2>
<p><code>rustdoc</code> contiene anche alcune altre opzioni da riga di comando,
per un'ulteriore personalizzazione:</p>
<ul>
<li><code>--html-in-header FILE</code>: inserisce il contenuto del file FILE alla fine
della sezione <code><head>...</head></code>.</li>
<li><code>--html-before-content FILE</code>: inserisce il contenuto del file FILE appena
dopo <code><body></code>, prima del contenuto mostrato (compresa la barra di ricerca).</li>
<li><code>--html-after-content FILE</code>: inserisce il contenuto del file FILE dopo