Καθαρή σχόλιο XML σε API Τεκμηρίωση

ψήφοι
15

Είναι ένας εύκολος τρόπος για να παράγουν τεκμηρίωση του MSDN στιλ από την έξοδο XML Visual Studio εκεί;
Δεν είμαι ασθενή αρκετή για να δημιουργήσει μια καλή XSLT για αυτό, γιατί ξέρω ότι δεν είμαι ο πρώτος άνθρωπος να διασχίσει τη γέφυρα.

Επίσης, δοκίμασα τη δημιουργία Sandcastle πρόσφατα, αλλά πραγματικά έκανε τα μάτια μου σταυρό. Είτε μου έλειπε κάτι σημαντικό στη διαδικασία ή είναι απλά πάρα πολύ που εμπλέκονται.

Ξέρω ότι κάποιος εκεί έξω έχει μια πολύ ωραία νεκρό απλή λύση.

Είμαι επαναλαμβάνοντας εδώ επειδή πιστεύω ότι η μορφοποίηση μου έκανε αυτή την παράγραφο μη ελκυστική ως εξής:

Έδωσα Sandcastle μια δοκιμή, αλλά είχε ένα πραγματικά σκληρό χρόνο να πάρει αυτό που έχει συσταθεί. Αυτό που πραγματικά έχουν στο μυαλό είναι κάτι πολύ πιο απλό.

Δηλαδή, αν εγώ απλά δεν καταλαβαίνω το Sandcastle διαδικασία. Φαινόταν σαν ένα φοβερό μέρος των επιπλέον αποσκευές μου μόνο και μόνο για να παράγει κάτι καλό για τους δοκιμαστές να εργαστεί με.

Δημοσιεύθηκε 03/08/2008 στις 23:03
πηγή χρήστη
Σε άλλες γλώσσες...                            


6 απαντήσεις

ψήφοι
9

Ψάχνετε για Sandcastle

Έργο Σελίδα: Sandcastle Τύπου

Blog: Sandcastle Blog

NDoc Γεννήτρια κώδικα τεκμηρίωση για την ΝΕΤ χρησιμοποιείται για να είναι το εργαλείο της επιλογής, αλλά η στήριξη έχει όλα, αλλά σταμάτησε.

Απαντήθηκε 03/08/2008 στις 23:12
πηγή χρήστη

ψήφοι
5

Θα πρέπει επίσης να χρησιμοποιήσετε το Sandcastle Builder Βοήθεια αρχείου. Σας παρέχει ένα ndoc όπως GUI για τη δημιουργία αρχεία βοήθειας, ώστε να μην χρειάζεται να κάνετε τίποτα από μια γραμμή εντολών.

Καλώς ήρθατε στο Πρόγραμμα Builder αρχείου Sandcastle Βοήθεια

Απαντήθηκε 19/09/2008 στις 16:22
πηγή χρήστη

ψήφοι
5

Ρίξτε μια ματιά στο Sandcastle , η οποία κάνει ακριβώς αυτό. Είναι επίσης ένα από τα πιο απλούστερες λύσεις εκεί έξω, και είναι περισσότερο ή λιγότερο το εργαλείο επιλογής, τόσο σε μακροπρόθεσμο ορίζοντα, ίσως θα μπορούσαμε να σας βοηθήσει να ρυθμίσετε Sandcastle αν καθορίσετε ποια ζητήματα που ανέκυψαν κατά την εγκατάσταση;

Απαντήθηκε 03/08/2008 στις 23:14
πηγή χρήστη

ψήφοι
3

Ακολουθήστε αυτό το απλό άρθρο 5 βήμα και είστε λίγο πολύ γίνεται. Ως μπόνους που μπορείτε να χρησιμοποιήσετε H2Viewer σε προβολή HTML αρχεία 2.x Βοήθεια.

Απαντήθηκε 04/08/2008 στις 11:31
πηγή χρήστη

ψήφοι
3

Μόλις συσταθεί Sandcastle και πάλι. Δοκιμάστε να το εγκαταστήσετε (η απελευθέρωση Μάιος 2008) και την αναζήτηση για SandcastleGui.exe ή κάτι παρόμοιο (είναι στο φάκελο τα παραδείγματα ή έτσι).

Κάντε κλικ στο κουμπί Προσθήκη Συνέλευση και να προσθέσετε Συνέλευσης ή Συνελεύσεις σας, προσθέστε τα αρχεία .xml Τεκμηρίωσης (αυτά που παράγονται από τον compiler, εάν έχετε ενεργοποιήσει αυτή τη δυνατότητα) και στη συνέχεια να οικοδομήσουμε.

Θα πάρει κάποιο χρόνο, αλλά το αποτέλεσμα θα αξίζει τον κόπο. Στην πραγματικότητα, θα αναζητήσετε την ουσία από το MSDN, οπότε προκύπτει τεκμηρίωση σας θα έχει επίσης την κλάση κληρονομιάς σε όλη τη διαδρομή προς τα κάτω για να System.Object με τις συνδέσεις με MSDN και τέτοια.

Sandcastle φαίνεται λίγο περίπλοκη στην αρχή, ειδικά όταν θέλετε να το χρησιμοποιήσετε σε μια αυτοματοποιημένη κατασκευή, αλλά είμαι απολύτως βέβαιος ότι θα αξίζει τον κόπο.

Επίσης, ρίξτε μια ματιά στο Sandcastle Builder Βοήθεια αρχείων , αυτή είναι μια κάπως πιο προχωρημένο γραφικό περιβάλλον για αυτό.

Απαντήθηκε 04/08/2008 στις 11:27
πηγή χρήστη

ψήφοι
2

Χρησιμοποιώ NDoc3

Απαντήθηκε 21/02/2010 στις 23:12
πηγή χρήστη

Cookies help us deliver our services. By using our services, you agree to our use of cookies. Learn more