Pour autant que je comprends votre question sur la création d'une documentation pour un cas d'utilisation de DLL externe, je vois deux façons possibles que vous pouvez aller:
- « manque » notes pour tous les articles de la DLL externe que vous pourrait vouloir documenter ou/et
- ajouter des sujets conceptuels à votre propre documentation de programme.
Ma solution échantillon projet WindowsApplication2 a un formulaire pour ajouter deux valeurs à l'aide d'un simple PDUNZDLL. Un projet de générateur de fichiers d'aide de Sandcastle "Documentation1" a été ajouté et deux sources de documentation (à ce stade sans fichier de commentaires XML, voir le premier instantané ci-dessous). Vous savez, une DLL sans fichier de commentaires XML entraîne un résumé rouge manquant.
Solution proposée (1):
Créer un fichier de commentaires XML vide comme ce qui suit et nommez après l'assemblage avec une extension .xml par exemple PDUNZDLL.xml
<?xml version="1.0"?>
<doc>
<assembly>
<name>PDUNZDLL</name>
</assembly>
<members>
</members>
</doc>
Enregistrer ce fichier dans le dossier de débogage par exemple D:\Visual-Studio-2015\Projects\WindowsApplication2\WindowsApplication2\bin\Debug
- Double-cliquez sur le "Propriétés du projet" (voir le deuxième cliché ci-dessous)
- Dans la boîte de dialogue Configurations de composants, ajoutez le " IntelliSense Component "pour le projet.
- Sélectionnez "Balises manquantes" et définissez les propriétés Afficher les balises manquantes du projet à votre convenance. Cela forcera la construction à ajouter des notes "manquantes" pour tous les éléments que vous pourriez vouloir documenter.
- Générez le projet et vous trouverez un nouveau fichier de commentaires XML nommé après l'assembly dans le dossier de sortie du projet, par ex.
D:\Visual-Studio-2015\Projects\WindowsApplication2\Documentation1\Help
- Modifiez les éléments
<member> dans le fichier de commentaires XML pour ajouter les commentaires souhaités pour chaque membre, comme indiqué dans le deuxième instantané.
Lorsque vous avez terminé, remplacez le fichier de réservation d'origine, p.D:\Visual-Studio-2015\Projects\WindowsApplication2\WindowsApplication2\bin\Debug\PDUNZDLL.xml avec celui généré à partir de la construction avec vos commentaires édités. ReBuild votre projet de documentation.
Cela prend bien sûr beaucoup de temps en tant que création d'aide pour les applications. Et c'était en fait la tâche du développeur DLL.
Solution proposée (2):
lecture entre vos lignes » ... afin que les autres puissent comprendre pourquoi je fais certains appels que je fais à ces fichiers DLL externes " m'amène à la suggestion d'ajouter une documentation supplémentaire à votre propre programme. Donc, ce que je veux dire est d'ajouter des sujets conceptuels décrivant comment vous appelez les caractéristiques des fichiers DLL externes.
J'ai enlevé la DLL sous la rubrique « Documentation Sources », a ajouté un nouveau dossier « ExternalDLL », a ajouté un nouvel élément conceptuel et Walkthrough, double-cliquez sur ContentLayout.content dans l'explorateur de solution, et a fait toutes les étapes de contenu mise en page, ReBuild le projet de documentation résultant dans un fichier d'aide comme indiqué dans le troisième instantané ci-dessous (voir aussi les informations d'arrière-plan).
création heureuse d'aide!
Cela pourrait aider: https://ewsoftware.github.io/SHFB/html/f5b58289-dd25-45b6-b616-5b8af6ba3739.htm#CreateComments – IronGeek
Comment consommez-vous les dll? Vous ne pouvez pas créer un wrapper autour des DLL? De cette façon, vous pouvez choisir des noms de fonctions qui pourraient être plus pertinents pour votre application ainsi que commenter à la fois votre propre fonction et les appels à la DLL dans l'implémentation de l'encapsuleur. Vous avez également l'avantage de faciliter l'échange de la DLL pour autre chose. – David