共用方式為

/doc (C# 編譯器選項)

  • 發行項

/doc 選項允許您將文件註解置於 XML 檔中。

/doc:file

Arguments

  • file
    XML 的輸出檔，它會填入 (Populate) 編譯的原始程式碼檔內的註解。

備註

在原始程式碼檔中，可以處理位於下列項目前面的文件註解，並將其加入到 XML 檔中：

包含 Main 的原始程式碼檔會先輸出至 XML。

若要將產生的 .xml 檔案運用於 IntelliSense 功能，這個 .xml 檔案名稱就必須和您要支援的組件具有相同檔名，然後再確定此 .xml 檔案與該組件是位於相同的目錄中。 因此，在 Visual Studio 專案中參考組件時，同時也就可以找到 .xml 檔案。 如需詳細資訊，請參閱提供程式碼註解。

除非您使用 /target:module 編譯，否則 file 將會包含 <assembly></assembly> 標記 (Tag)，以便指定其包含用編譯輸出檔的組建資訊清單之檔案名稱。

注意事項注意事項

/doc 選項會套用至所有輸入檔；如果在 [專案設定] 中設定該選項，則會套用至專案中的所有檔案。若要停用特定檔案或程式碼區段的文件註解相關警告，請使用 #pragma warning。

如需從程式碼的註解產生文件方法的詳細資訊，請參閱建議的文件註解標記。

在 Visual Studio 開發環境中設定這個編譯器選項

  1. 開啟專案的 [屬性] 頁面。

  2. 按一下 [建置] 索引標籤。

  3. 修改 [XML 文件檔] 屬性。

如需如何以程式設計方式設定這個編譯器選項的詳細資訊，請參閱 DocumentationFile。

請參閱

工作

如何：修改專案屬性和組態設定

其他資源

C# 編譯器選項