Archiwum dnia: Sunday August 30th, 2009

Visual Studio auto comment PlugIn – AtomineerUtils

Opublikowany przez
Odpowiedz

Dzisiaj poszukując łatwego sposobu na dokumentację swojego projektu znalazłem taki oto plugIn do Visual Studio. Plugin po instalacji i odrobinie konfiguracji potrafi z powietrza wygenerować zupełnie sensowny zalążek komentarza dokumentującego:
Było:

1
2
3
4
5
6
7
8
9
10
    class archive
    {
    public:
        void log(response resp ) ;
        void store( response resp ) ;
        int getNextSerialNumber() ;
        void init() ;
    private:
        int actualSerial ;
    } ;

Po ustawieniu karetki przed każdą deklaracją funkcji oraz na początku klasy i wywołaniu skrótu CTRL+SHIFT+D otrzymałem:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
    /**
     * <summary>   
     * The <c>archive</c> Class is responsible for logging the service user activity and storing
     * issued tokens for future verification.
     * </summary>
     *
     * <remarks>    Root, 2009-08-30. </remarks>
    **/

    class archive
    {
    public:

        /**
         * <summary>    Logs. </summary>
         *
         * <remarks>    Root, 2009-08-30. </remarks>
         *
         * <param name="resp">  The resp. </param>
        **/

        void log(response resp ) ;

        /**
         * <summary>    Stores. </summary>
         *
         * <remarks>    Root, 2009-08-30. </remarks>
         *
         * <param name="resp">  The response to store. </param>
        **/

        void store( response resp ) ;

        /**
         * <summary>    Gets the next serial number. </summary>
         *
         * <remarks>    Root, 2009-08-30. </remarks>
         *
         * <returns>    The next serial number. </returns>
        **/

        int getNextSerialNumber() ;

        /**
         * <summary>    Initialises this object. </summary>
         *
         * <remarks>    Root, 2009-08-30. </remarks>
        **/

        void init() ;
    private:
        int actualSerial ;
    } ;

Tak, dokładnie – to narzędzie potrafi wywnioskować (SIC!!) do czego służą poszczególne funkcje.
Z pewnością to ułatwi i uprzyjemni żmudne godziny tworzenia dokumentacji.