Eine Möglichkeit, eine Klasse, eine Methode, insbesondere eine bestimmte Codezeile in C# zu verknüpfen Kommentar

Ich möchte eine Art Dokumentation mit Links in Code erstellen, die auf ein Ziel verweisen. Das Ziel könnte ein Class oder ein Method oder eine spezifische Codezeile sein. (zeigt auf eine bestimmte Codezeile ist die wichtigste)
Ich dachte an eine Erweiterung für VS2010 oder ein bestimmtes Kommentar-Tag.
Gibt es eine Möglichkeit, Links dieser Art zu erstellen?Eine Möglichkeit, eine Klasse, eine Methode, insbesondere eine bestimmte Codezeile in C# zu verknüpfen Kommentar

Quelle

2012-10-07 HichemSeeSharp

Javadoc konnte genau diese Art von Sache tun. Als Microsoft .Net 1.1 veröffentlichte, versuchten sie, Javadoc mit "NDoc" nachzuahmen. Dann tötete NDoc zugunsten von "Sandcastle": http://weblogs.asp.net/fmarguerie/archive/2006/02/16/ndoc-project-stalled-no-version-2-microsoft.aspx. Ihr aktuelles XML-Ding ist, offen gesagt, ein Durcheinander ... VORSCHLAG: Erwägen Sie stattdessen, [Doxygen] (http://www.stack.nl/~dimitri/doxygen/) zu verwenden. – paulsm4

@HichemC, versuche [dies] (http://hyperaddin.codeplex.com/) –

Ich habe es gerade versucht und ich denke, es funktioniert gut - registrieren Sie einfach das Add-in und lesen Sie die Hilfe.htm, um zu lernen, wie man es benutzt . Wenn Sie irgendwelche Probleme haben (weil es für VS 2005 & 2008 gebaut wurde), können Sie einfach die Lösung neu erstellen (es ist Open Source) und es sollte gut funktionieren. –

Xml Kommentar + Sandburg kann sein, was Sie brauchen. Sie können bestimmte Klasse oder Methode Referenz

<see cref=".."/>

und Referenzparametern

<paramref name=".."/>

Verwendung Es gibt jedoch keine direkte Methode bestimmte Codezeilen zu verweisen, aber Sie können mit

bestimmte #region Referenz

<code source="$sourcefile$" region="$regionname$"/>

Bitte beachten Sie: XML Comments Guide 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.

Quelle

2012-10-15 12:57:17 Liu

Ziemlich hilfreiche Antwort. Vielen Dank – HichemSeeSharp

Eine Möglichkeit, eine Klasse, eine Methode, insbesondere eine bestimmte Codezeile in C# zu verknüpfen Kommentar

Antwort

Verwandte Themen