最近我開始使用///
來評論我的C#代碼,而不是//
或/*
,因爲它使用起來更簡單。今天,我開始想知道爲什麼有不同的類型,並遇到this SO question其中指出///
註釋是用於生成XML文檔。C#// vs ///評論
對於Google上的評論類型和其他評論,我無法找到任何建議,我認爲這兩者無關。到目前爲止,我還沒有從使用///
發表任何不良影響發表評論,但我不想現在就養成一種習慣,以後再忘記。據我所知,如果在評論中沒有元標記,它不會被識別爲文檔(或者我完全錯了嗎?)
在我用///
註釋謎語之前,是這種類型的評論一個大的禁忌?這樣評論會有潛在的問題嗎?
三個斜線用於描述已聲明的方法或函數。我只知道這一點。 –
我其實剛剛回答了一個問題,解釋今天的差異。 http://stackoverflow.com/questions/13366400/should-you-use-xml-comments-on-field-variables-properties-constructors/13366665#13366665 – evanmcdonnal
是什麼讓你認爲代碼文檔是否定的? – Euphoric