Dokumentieren mit Sandcastle: Verweisen auf Enum-Wert mit <see>

Question

Ich verwende Sandcastle 2.4.10520 und Sandcastle Help File Builder 1.8.0, um eine CHM-Hilfedatei zu generieren.

In meiner Dokumentation verwende ich <see> Tags.

Wenn ich versuche, eine enum wie <see cref="NumberStyles"/> beziehen, funktioniert es perfekt.

Wenn ich versuche, einen Enum-Wert wie <see cref="NumberStyles.AllowTrailingWhite"/> verweisen ich auf einen Link in der Dokumentationsdatei erhalten, aber der Link führt mich zu einem MSDN Page not found

Ich bekomme keine Warnungen - meine xml Dokumentation korrekt ist.

Ich habe festgestellt, dass MSDN-Seiten, die sich auf einen Aufzählungswert beziehen, auch einen Link Seite nicht gefunden haben. Zum Beispiel: UInt64.Parse Method (String, NumberStyles, IFormatProvider) bezieht sich auf NumberStyles.AllowHexSpecifier und dies führt zu einem anderen MSDN Page not found.

Sollte ich auf die enum anstelle der enum Wert beziehen?

Was soll ich tun, um eine Enum zu verweisen? Ist es überhaupt möglich?

Answer 1

Die Tatsache, dass es auf MSDN geschieht, verheißt nichts Gutes. Haben die Enum-Werte eine XML-Dokumentation?

Wenn ich mich richtig erinnere, sollte es Einstellungen in SHFB geben, mit denen Sie die Generierung von Dokumentation für Mitglieder erzwingen können, die kein XML haben - oder vielleicht eine Einstellung, mit der Sie Mitglieder ausschließen können, die kein XML-Dokument haben. Unabhängig davon, geben Sie die Einstellungen einmal an, um sicherzustellen, dass Sie die Enum-Mitglieder auf diese Weise nicht ausschließen.

Sonst sollte es Dokumentation für jedes Mitglied generieren, und Enum-Werte sind Mitglieder von Typen die gleichen wie ein const oder ein statisches Feld wäre.

EDIT: Es sieht aus wie zumindest auf der neueren MSDN-Website, individuelle Enum-Werte sind nicht ihre eigene Seite gegeben. Schauen Sie sich zum Beispiel die NumberStyles enum an. In diesem Fall haben Sie möglicherweise keine bessere Option als nur auf die Enumeration zu verlinken.