18

/* */各 Java ファイルには著作権に関するコメントがありますが、どちらを使用すればよい/** */かわかりません。

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

また

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

4 に答える 4

11

このかなり古い（1999年頃）Sunのコーディング規約文書はを示唆して/* */います。

具体的には、クラス/インターフェースファイルの次のレイアウトを提案します。

  • 冒頭のコメント

    /*
 * Classname
 * Version information
 * Date
 * Copyright notice
 */
  • packageおよびimportステートメント
  • クラスとインターフェースの宣言（クラスのJavadocコメントを含む-テーブルエントリ＃1を参照）。

例：

/*
 * 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 {
    ...
}
于 2011-11-30T03:25:10.880 に答える
10

Javadoc は、/** ... */コメントが文書化される宣言の直前にある場合にのみ、コメントを収集します。 package(package-info.java 以外) およびimport宣言はとにかく文書化されていないため、Javadoc はどちらの方法でもコメントを調べません。

Javadoc には関係ないので、「軽量」/* ... */バージョンを使用することもできます。

于 2011-11-30T09:51:49.637 に答える
4

オープンソースのJavaプロジェクトをいくつか読んだところ、それらはすべて使用していることがわかりました/* */

于 2011-11-30T02:58:44.843 に答える