每個java文件都有版權註釋,但我不知道應該使用哪一個:/* */
或/** */
?我應該使用/ * * /還是/ ** * /作爲java文件頂部的版權?
/*
* Copyright ...
*/
import java.util.*
...
或
/**
* Copyright ...
*/
import java.util.*
....
每個java文件都有版權註釋,但我不知道應該使用哪一個:/* */
或/** */
?我應該使用/ * * /還是/ ** * /作爲java文件頂部的版權?
/*
* Copyright ...
*/
import java.util.*
...
或
/**
* Copyright ...
*/
import java.util.*
....
這相當老(大約1999年)太陽coding conventions文件建議/* */
。
更具體地說,它表明了以下佈局爲你的類/接口文件(S):
開始評論
/*
* Classname
* Version information
* Date
* Copyright notice
*/
package
和import
聲明例子:
/*
* 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 {
...
}
如果使用/** */
文檔化工具將抓住它,所以你最好不要使用它:)
我只是看了一些開源Java項目,發現他們都使用/* */
Javadoc將只收集/** ... */
意見,如果他們是直接被記錄任何聲明之前。 package
(除package-info.java外)和import
聲明無論如何都沒有記錄,因此Javadoc不會以任何方式查看註釋。
由於對Javadoc無關緊要,您可以使用「不太重」的/* ... */
版本。
+1 [這裏是文檔參考](http://docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#comments)如果你想將它添加到你的答案。特別是註釋**的位置部分,其中規定:*「文檔註釋僅在緊靠類,接口,構造函數,方法或字段聲明之前放置」*。它也可以確定這個問題的討論:*「一個常見的錯誤是在類註釋和類聲明之間放置一個'import'語句,避免這種情況,因爲Javadoc工具會忽略類註釋。」* –
雖然這總是正確的事情?如果版權僅適用於代碼,該怎麼辦?如果Javadoc API的許可/受版權保護方式不同? –
對於問題中給出的示例代碼,這實際上是不正確的。請參閱[Paŭlo的回答](http://stackoverflow.com/a/8323983/29995)以及我的評論。 –
Javadoc不會像問題中的示例那樣在導入語句前抓取內容。 –