7
votes

C # Code XML Commentaire pour référence de fichier

Y a-t-il une balise pour une référence de fichier dans un commentaire de code XML? Le fichier est un fichier de script SQL. Je me demande simplement s'il y a un meilleur moyen que quelque chose comme celui-ci xxx

c# xml-comments

1 commentaires

Utilisez-vous ces commentaires XML pour générer un service d'aide HTML avec Sandcastle ou quelque chose?

4 Réponses :

0
votes

Il existe une telle chose comme une balise spéciale pour référence de fichier en XML. C'est méta-langueur sans ces limitations.

0 commentaires

7
votes

Vous pouvez utiliser un URI de fichier, cela le rend cliquant dans Visual Studio: XXX

4 commentaires

Merci. Est-il possible d'avoir un chemin relatif? fichier: // .. \ .. \ .. \ file.sql qui ne semble pas fonctionner

@Jml - Oui, ce serait (supposer que votre fichier est "C: \ Code \ Project \ Code \ Source.cs") "Fichier: ../ sql / fichier1.sql"

- Malheureusement, cela ne fonctionne pas, j'ai essayé /// fichier: ../../ base de données / employéduploadfileconfiguration_testdata ForFormavalidation .SQL et même testé avec une référence à un autre fichier dans le même dossier: /// Fichier: / /ÉligibilitéCriteriAformulatestSs.cs honte parce que cela serait assez utile pour les commentaires. Intellisense Link ne fonctionne pas

Oh, je suis désolé, il semble être relatif à l'emplacement de Devenv.exe (Visual Studio exécutable). Je ne sais pas comment j'ai manqué que: -s. Donc, cela ne fonctionne que pour des chemins absolus.

6
votes

Vous pouvez mélanger des éléments à partir d'autres espaces de noms, y compris XHTML, donc xxx

est autorisé, s'il est fait l'utilisation de puits ou non dépend de ce que vous utilisez pour transformer le XML dans quelque chose plus lisible. ToolTip-Utilisez au moins dans mon IDE ignore la balise et affiche le texte à l'intérieur (qui est ce que je voudrais dans un embout d'outil).

Bien sûr, ce n'est pas très utile sur une machine qui ne peut pas 't avoir le correct c: \ code \ projet1 \ sql \ file1.sql

0 commentaires

1
votes

Les balises les plus couramment utilisées sont répertoriées à http : //msdn.microsoft.com/en-us/library/5ast78AX (v = vs.71) .aspx . Il mentionne également que cela traitera "toute balise qui est valide xml" afin que vous ne vous limitaient pas à ceux-ci.

0 commentaires