txt - ¿Debo usar/**/ o/***/ para los derechos de autor en la parte superior de un archivo java?

modificar archivos txt en java

Question

Hay un comentario de copyright en cada archivo java, pero no sé cuál debo usar: /* */ o /** */ ?

 /*
  * Copyright ...
  */
 import java.util.*
 ...

o

/**
 * Copyright ...
 */
import java.util.*
....

Answer 1

Acabo de leer algunos proyectos Java de código abierto, encontré que todos usan /* */

Answer 2

Este documento de convenciones de codificación de Sun bastante antiguo (circa 1999) sugiere /* */ .

Más específicamente, sugiere el siguiente diseño para sus archivos de clase / interfaz:

• Comentarios iniciales

  /*
   * Classname
   * Version information
   * Date
   * Copyright notice
   */

• package y declaraciones de import
• Declaraciones de clase e interfaz (que incluyen comentarios de Javadoc para la clase; consulte la entrada de la tabla n. ° 1).

Ejemplo:

/*
 * MyClass
 *
 * v1.0
 *
 * 2011-11-29
 * 
 * This file is copyrighted in an awesome way.
 */
package com.example.mypackage;

import com.example.otherpackage;

/**
 * Javadoc comments for the class.
 */
public class MyClass {
    ...
}

Answer 3

Javadoc solo recopilará /** ... */ comentarios si están directamente antes de cualquier declaración para documentarse. package (aparte de en package-info.java) y las declaraciones de import no están documentadas de todos modos, por lo que Javadoc no mirará el comentario de ninguna manera.

Como no es importante para Javadoc, también puede usar la versión "menos pesada" /* ... */ .

Answer 4

Si usa /** */ herramientas de documentación lo agarrarán, así que será mejor que lo use :)