2009-06-08 8 views
1

Je crée une bibliothèque personnalisée de contrôles composites qui incluent leurs propres fichiers JavaScript en tant que ressources Web. J'ai DocProject en cours d'exécution pour générer ma documentation XML CHMs et ça fonctionne très bien.Documentation de commentaire XML JavaScript

Cependant, lorsque je mets ma solution en configuration "Release", l'exécution n'extrait toujours pas les commentaires XML des fichiers JavaScript incorporés et les inclut dans le fichier comments.xml généré ou le fichier de réflexion .org. Par conséquent, lorsque j'exécute ma version DocProject, les commentaires que j'ai inclus dans mes fichiers JavaScript sont exclus, ce qui rend ma documentation imparfaite.

Des pensées? J'aimerais pouvoir inclure la documentation JavaScript directement dans le CHM généré.

J'ai depuis regardé AjaxDoc sur CodePlex, et n'ai pas eu de succès avec lui après environ 6 heures. Oui, j'ai déjà contacté Bertrand LeRoy (créateur d'AjaxDoc) et j'espère entendre quelque chose en retour, même si je suis sûr qu'il est très occupé.

Répondre

0

Votre question ne semble pas avoir à voir avec javascript ou xml, mais plutôt avec DocProject, que vous voudrez peut-être ajouter dans vos tags.

+0

Le fichier .XML généré par le framework .NET n'exporte pas les commentaires XML dans le fichier javascript. Ce n'est pas la faute de DocProject, c'est le fait que les "COMMENTAIRES" de mon fichier "JAVASCRIPT" n'apparaissent pas dans le fichier "DOCUMENTATION" généré par ".NET". Peut-être que maintenant vous comprendrez le marquage. :) – Jonathan

0

Quelques points qui peuvent vous aider à comprendre ce qui se passe:

Les fichiers doc XML sont compilés à partir des commentaires sur le code source compilé. Javascript n'est pas compilé. Le seul support que Visual Studio a pour les docs xml sur JS est dans la fenêtre de l'éditeur de code JS pour intellisense et l'achèvement du code. C'est tout.

AjaxDoc est une bête assez complexe qui fonctionne uniquement sur JS qui est construit en utilisant MsAjax et exploite son système de frappe.

AjaxDoc ne peuvent pas créer des fichiers xml pour POJO (javascript « ole plaine)

Je ne retiendrais pas mon souffle pour toute réponse de Betrand.

Je travaille actuellement sur un moteur de documentation POJO mais mon travail m'occupe. Vous pouvez voir un prototype de construction de doc à la demande dans le navigateur/docs du répertoire this download

Désolé, les nouvelles ne sont pas meilleures.