Martin Speiser: Klassenbeschreibungen

Beitrag lesen

Hallo Philipp,

also neben dem Javadoc gibt es noch was ähnliches von MS für .NET Sprachen, allerdings XML basierend. Womit du es dann machst, ist aber relativ egal, auf das Endergebnis kommt es an.

Wenn du ne Weile mit Java arbeitest, bzw. mit der Hilfe, wirst du feststellen, dass das beste Tool nichts nutzt, wenn man die Doku nebenher macht. Was mich an den Java-Hilfen (sei's nun Java selbst, oder Xalan, oder für andere Bibliotheken) stört, sind zu kurz gehaltene Beschreibungen der Methoden und ihrer Parameter, nichtssagende Beispiele, Sätze wie "see function above" (schön, die steht im Source oben. Nicht in dem, was Javadoc generiert), und Ähnliches. Da liegt die Krux, nicht ob man nun Javadoc nimmt, das .NET-Äquivalent, oder was Eigenes. Man braucht Selbstdisziplin.

Ja, ich nehme mich nicht aus. ;-)

Gruß,
Martin

0 43

Klassenbeschreibungen

Philipp Hasenfratz
  • projektverwaltung
  1. 0

    Klassenbeschreibungen - Beispiele? - Vorlagen?

    Philipp Hasenfratz
    1. 0
      Simon Reinhardt
      1. 0
        Philipp Hasenfratz
  2. 0
    Andreas Korthaus
    1. 0
      Philipp Hasenfratz
  3. 0
    Philipp Hasenfratz
    1. 0
      Simon Reinhardt
      1. 0
        Martin Speiser
  4. 0
    Martin Speiser
    1. 0
      Philipp Hasenfratz
      1. 0
        Martin Speiser
        1. 0
          Philipp Hasenfratz
      2. 0
        Simon Reinhardt
        1. 0
          Philipp Hasenfratz
  5. 0

    Ein erster Prototyp zum testen - Komponenten-Beschreibungen

    Philipp Hasenfratz
    • perl
    1. 0
      Simon Reinhardt
      1. 0
        Philipp Hasenfratz
        1. 0

          Status

          Philipp Hasenfratz
          1. 0
            Simon Reinhardt
            1. 0
              Philipp Hasenfratz
              1. 0
                Simon Reinhardt
                1. 0
                  Philipp Hasenfratz
      2. 0

        XSLT Tranformierung der Componenten-XML-Datei

        Philipp Hasenfratz
        • xsl
        1. 0
          Thomas J.S.
          1. 0
            Philipp Hasenfratz
            1. 0
              Thomas J.S.
              1. 0
                Philipp Hasenfratz
                1. 0
                  Thomas J.S.
    2. 0
      Thomas J.S.
      1. 0
        Philipp Hasenfratz
      2. 0
        Simon Reinhardt
        1. 0
          Thomas J.S.
        2. 0
          Philipp Hasenfratz
          1. 0
            Thomas J.S.
            1. 0
              Philipp Hasenfratz
              1. 0
                Thomas J.S.
                1. 0
                  Philipp Hasenfratz
                  1. 0
                    Thomas J.S.
                    1. 0
                      Philipp Hasenfratz
                      1. 0
                        Thomas J.S.
                        1. 0
                          Philipp Hasenfratz
  6. 0
    Philipp Hasenfratz