Personalizza i generatori di documenti standard C # (commenti XML) in Visual Studio

  • C’è qualche altro tipo di collegamento al generatore di documentazione per C # (come /// Genera il codice function() ) o qualsiasi elemento strumento (come firma in e-mail @ outlook) in VS IDE, per seguire la codifica MS Standard e la documentazione e far capire agli altri co-sviluppatore che lavora sullo stesso progetto.
  • Come modificare il formato del documento generato nell’IDE di visual stdio in base al formato di commento predefinito nel formato di commento personalizzato mostrato di seguito.

Ex:

  1. **Default Format** // Name: // Author: // Description:  // Parameters:  // Returned Value:  2. **New Custom Format** // Application:   // Created Developer:  // Created Date:  // Last Modified: // Last Modified Developer: // Parameters:  // Return Type:  // Description:  

Uno degli strumenti che consentono di personalizzare il commento XML predefinito è il nostro VSdocman . È ansible pre-definire il commento per ogni tipo di elemento del codice (metodo, proprietà, …) e anche per un particolare nome o tipo. Si chiama modelli di commento . Quindi nell’editor di codice, fare clic con il tasto destro e selezionare “Aggiungi commento XML”. Inoltre, puoi generare una documentazione (HTML, CHM, docx, VS help, …) dai tuoi commenti con lo strumento.

Questo è ora> 6 mesi, ma penso che la risposta a questa domanda: cambiare lo snippet di commento XML predefinito in Visual Studio ti porterà dove vuoi essere. Basta aggiungere la struttura dei commenti personalizzati alla sezione CDATA e tutto è pronto.