Javadoc header

[forgetITrob]

What about this Javadoc header for all our files?

/**
   [Class description.  The first sentence should be a good summary of the class since it
   will be displayed as the class summary on the Javadoc package page.]

   [Other notes, usage instructions and/or examples, etc.]

   @author [Name]
   @version $Revision: 0.0.0.1 $ $Date: 2011/03/31 $
**/

Should we add the last modification date or mention that we use the appache license?

[David-Henn]

the header looks good i think the last modification date isn't that interesting

On 31.03.2011 01:22, forgetITrob wrote:

What about this Javadoc header for all our files?

/** [Class description. The first sentence should be a good summary of the class since it will be displayed as the class summary on the Javadoc package page.]

[Other notes, usage instructions and/or examples, etc.]

@author<A HREF="mailto:[Email address]">[Name]</A>
@version $Revision: 0.0.0.1 $ $Date: 2011/03/31 $

**/

Should we add the last modification date or mention that we use the appache license?

[ChornHulio]

I don't know if a version number makes really sense. How about a "since" field?

I looked for some java projects under Apache license and found e.g. this:

/*
 *  Copyright 2001-2005 Stephen Colebourne
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package org.joda.time;

/**
 * DateTimeConstants is a non-instantiable class of constants used in
 * the date time system. These are the ISO8601 constants, but should be
 * used by all chronologies.
 * 

 * DateTimeConstants is thread-safe and immutable.
 *
 * @author Stephen Colebourne
 * @author Brian S O'Neill
 * @since 1.0
 */
public class DateTimeConstants {
    ...
}

[author-zz]

why am i getting this?

Mit freundlichen Grüßen,

Dipl. Ing. Meinrad Recheis eqqon GmbH Friedmanngasse 32/20 1160 Wien, Österreich Tel.: +43 (0) 680-31-800-37 Fax: +43 (0) 1-25-330-339-356 meinrad.recheis@eqqon.com

Firma: eqqon GmbH Rechtsform: Gesellschaft mit beschränkter Haftung Firmensitz: Wien Firmenbuchnummer: FN 327919 i Firmenbuchgericht: Handelsgericht Wien

eqqon Disclaimer / Legal notice: http://www.eqqon.com/index.php/Disclaimer

On 31.03.2011 08:02, David-Henn wrote:

the header looks good i think the last modification date isn't that interesting

On 31.03.2011 01:22, forgetITrob wrote:

What about this Javadoc header for all our files?

/** [Class description. The first sentence should be a good summary of the class since it will be displayed as the class summary on the Javadoc package page.]

 [Other notes, usage instructions and/or examples, etc.]

 @author<A HREF="mailto:[Email address]">[Name]</A>
 @version $Revision: 0.0.0.1 $ $Date: 2011/03/31 $

**/

Should we add the last modification date or mention that we use the appache license?

[David-Henn]

Hallo Herr Rechis,

vielleicht, weil wir in unserer email @author stehen haben. GitHub muss das wohl falsch interpretiert haben. Wir werden das in Zukunft berücksichtigen und auch GitHub Messages nicht mehr per email antworten.

Mit freundlichen Grüßen David Henn

On 31.03.2011 15:34, author wrote:

why am i getting this?

Mit freundlichen Grüßen,

Dipl. Ing. Meinrad Recheis eqqon GmbH Friedmanngasse 32/20 1160 Wien, Österreich Tel.: +43 (0) 680-31-800-37 Fax: +43 (0) 1-25-330-339-356 meinrad.recheis@eqqon.com

Firma: eqqon GmbH Rechtsform: Gesellschaft mit beschränkter Haftung Firmensitz: Wien Firmenbuchnummer: FN 327919 i Firmenbuchgericht: Handelsgericht Wien

eqqon Disclaimer / Legal notice: http://www.eqqon.com/index.php/Disclaimer

On 31.03.2011 08:02, David-Henn wrote:

the header looks good i think the last modification date isn't that interesting

On 31.03.2011 01:22, forgetITrob wrote:

What about this Javadoc header for all our files?

/** [Class description. The first sentence should be a good summary of the class since it will be displayed as the class summary on the Javadoc package page.]

  [Other notes, usage instructions and/or examples, etc.]

  @author<A HREF="mailto:[Email address]">[Name]</A>
  @version $Revision: 0.0.0.1 $ $Date: 2011/03/31 $

**/

Should we add the last modification date or mention that we use the appache license?

[forgetITrob]

I think ChornHulio's idea is quite good but I would use the mail adress in the autor field instead, like I suggested it. The next point is, do we need a date of creation or is it not that important because we have the timestamps of the files?

[ChornHulio]

We have the history of the git commits...

[ChornHulio]

So my suggestion would be:

/*
 * Copyright 2011 DHBW Stuttgart Campus Horb
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either 
 * express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package forgetit.x;

import org.y;

import forgetit.z;

/**
 * Short class description
 * 
 * Longer class description if necessary. 
 * e.g. threadsafeness or special dependencies.
 * 
 * @author ChornHulio (chornhulio@web.de)
 * @since 0.0
 */ 
public class MyClass { 
    ... 
} 

(The mail adress is a normal html-mailto-link:

a href="mailto:[mailadress]">mailadress</a

--> don't forget the angle brackets around the statement)

[David-Henn]

yep i think thats good. the exact date isn't that interesting, i think. If there's somebody, who wants to know the date, he can search in the git history. Much more important is the name of the author and his amail address

On 01.04.2011 13:19, ChornHulio wrote:

So my suggestion would be:

/*
  * Copyright 2011 DHBW Stuttgart Campus Horb
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
  * express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
package forgetit.x;

import org.y;

import forgetit.z;

/**
  * Short class description
  *
  * Longer class description if necessary.
  * e.g. threadsafeness or special dependencies.
  *
  * @author ChornHulio (chornhulio@web.de)
  * @since 0.0
  */
public class MyClass {
     ...
}

(The mail adress is a normal html-mailto-link:

a href="mailto:[mailadress]">mailadress</a

--> don't forget the angle brackets around the statement)

[yvesf]

https://github.com/blog/821-mention-somebody-they-re-notified @yvesf @David-Henn @ChornHulio. Dieses Feature ist #fail

[David-Henn]

jup

On 01.04.2011 15:07, yvesf wrote:

https://github.com/blog/821-mention-somebody-they-re-notified @yvesf @David-Henn @ChornHulio. Dieses Feature ist #fail