Όλοι όσοι έχει χρειαστεί να γράψουμε documentation, έχουμε χρησιμοποιήσει διάφορα εργαλεία για να πάρουμε το επιθυμητό αποτέλεσμα.
Ένα από αυτά τα εργαλεία, που είναι πολύ διαδεδομένο στους προγραμματιστές, είναι και το nDoc.
Το nDoc δημιουργεί class library documentation για .NET assemblies σε γλώσσα C#.
Με πολύ λίγη δουλειά και λίγες ρυθμίσεις μπορούμε να ικανοποιήσουμε τα απαιτητικά αφεντικά, που δεν σκέφτονται πόσο κοπιάσαμε να δημιουργήσουμε, αυτό που οι ίδιοι δεν ξέρουν τι ακριβώς έχουν ζητήσει και να τους παρουσιάσουμε ένα πλήρες documentation.
Με το nDoc ήταν όλα καλά εφόσον η έκδοση του .Net Framework ήταν στην έκδοση 1.0 ή 1.1.
Το πρόβλημα εμφανίστηκε, όταν στη αγορά άρχισε να κινείτε το .net Framework 2.0. Εκεί το nDoc δεν δούλευε και είχαν πεί ότι θα το υλοποιήσουν στην επόμενη έκδοση. Με ένα πολύ μικρό τρικ όμως, το nDoc παίζει κανονικά και για .net Framework 2.
Η λύση είναι πολύ απλή. Θα πρέπει να δημιουργήσουμε ένα config αρχείο για το NDocGui.exe που θα βάλουμε τις ρυθμίσεις που χρειάζονται.
Το αρχείο NDocGui.exe.config έχει τη μορφή:
<?xml version="1.0" ?>
<configuration>
<startup>
<supportedRuntime version="v2.0.50727" />
<supportedRuntime version="v1.1.4322" />
<requiredRuntime version="v1.1.4322" />
</startup>
</configuration>
Από ότι παρατηρείτε το μόνο που κάνουμε είναι να προσθέτουμε απο ένα element με την έκδοση που έχουμε στο .net Framework (υποστηρίζει πολλαπλές εκδόσεις).
Προσοχή στο build της έκδοσης που χρησιμοποιείτε. Ελέγξτε πρώτα στο VS το build του framework που έχετε για να μπορεί να δουλέψει το ndoc.
Άντε και καλά documentations για framework 2.0
πηγή για download: http://ndoc.sourceforge.net/