Convenzione .NET // vs /// Commenti
https://stackoverflow.com/questions/181015
-
05-07-2019 - |
italiano
english
français
española
中国
日本の
العربية
Deutsch
한국어
Português
RussianDomanda
Sto solo controllando F #, quindi mi scuso se questa è una domanda sciocca, ma nel progetto VS2008 F # CTP 1.9.6.2 'Tutorial', sia // che /// sono usati per commentare il codice.
Esiste una differenza funzionale tra i commenti di due barre e tre di barra oppure è convenzionale (come appare nel codice tutorial) commentare una funzione con /// e usare // per tutto il resto?
Soluzione
L'uso di tre barre (///) è una convenzione C # per Commenti sulla documentazione XML adottato anche da F #.
Altri suggerimenti
/// è per i commenti sulla documentazione. VS la utilizzerà durante la generazione di informazioni intellisense.
È simile a / * comment * / vs / ** commento documentato * / in Java.
Quest'ultimo funziona allo stesso modo, ma è anche riconosciuto dal software di documentazione come documentazione per sviluppatori, non solo una nota.
/// o '' 'per C # e VB.Net sono molto più che commenti interni. Se si attiva File di documentazione XML nelle proprietà del progetto, è possibile utilizzare Sandcastle e la Guida HTML per generare quattro diversi tipi di documentazione (file e siti Web). Vedi https://github.com/EWSoftware/SHFB/wiki e microsoft docs . Inoltre, questo può essere aggiunto al processo di configurazione continua.
