Eine Möglichkeit, eine Verknüpfung zu einer Klasse, einer Methode, insbesondere einer bestimmten Codezeile in C # -Kommentar herzustellen

8

Ich möchte eine Art Dokumentation erstellen, die Links in Code verwendet, die auf ein Ziel verweisen. Das Ziel könnte ein Class oder ein Method oder eine bestimmte Codezeile sein. ( zeigt auf eine bestimmte Codezeile ist das wichtigste ) Ich habe an eine Erweiterung für VS2010 oder ein bestimmtes Kommentar-Tag gedacht.
Gibt es eine Möglichkeit, Links dieser Art zu erstellen?

    
HichemSeeSharp 07.10.2012, 16:12
quelle

1 Antwort

9

Xml comment + sandcastle könnte das sein, was du brauchst. Sie können mit

auf die angegebene Klasse oder Methode verweisen %Vor%

und Referenzparameter mit

%Vor%

Es gibt jedoch keine direkte Methode, um bestimmte Codezeilen zu referenzieren, aber Sie können bestimmte # Regionen mithilfe von

referenzieren %Vor%

Siehe: Leitfaden für XML-Kommentare Seite 20.

Beachten Sie, dass der Code, auf den Sie verweisen, direkt anstelle eines Links angezeigt wird. Es ist nicht perfekt, aber ich hoffe, es hilft.

    
Liu 15.10.2012, 12:57
quelle