Ich versuche, Codebeispiele in die CHM-Datei einzufügen, die ich mit Sandcastles erzeuge. Hier ist, was ich bisher habe:
%Vor%Das ist sehr chaotisch und ich möchte diesen Code lieber nicht in meiner .cs-Datei haben. Gibt es eine Möglichkeit, diesen Beispielcode in eine separate CS-Datei zu stellen und in irgendeiner Weise im Kommentar darauf Bezug zu nehmen? Also würde ich stattdessen so etwas haben:
%Vor% Sicher. Angenommen, Sie erstellen eine externe Codedatei, Example.cs. In dieser Datei platzieren Sie Ihr Beispiel, umgeben von einem benannten region .
Im XML-Kommentar für das Element, für das Sie das Beispiel erstellen, geben Sie die Quelle des externen Codebeispiels an:
%Vor%Die Angabe der Sprache ist für C # nicht erforderlich, da dies die Standardeinstellung ist. Wenn Sie die Region nicht angeben, enthält sie den gesamten Code in Ihrer Beispieldatei.
Beachten Sie auch, dass der Quelldateipfad relativ zu Ihrer SHFB-Projektdatei ist, nicht unbedingt die Visual Studio-Projektdatei. Wenn Sie die Codeblockkomponente konfigurieren (in SHFB - & gt; Projekteigenschaften - & gt; -Komponenten), können Sie einen anderen Basispfad angeben.
Tags und Links .net c# sandcastle chm