प्रत्येक जावा फ़ाइल में एक कॉपीराइट टिप्पणी है, लेकिन मुझे नहीं पता कि मुझे किस का उपयोग करना चाहिए: /* */ या /** */?क्या मुझे जावा फ़ाइल के शीर्ष पर कॉपीराइट के लिए/* */या/** */का उपयोग करना चाहिए?
/*
* Copyright ...
*/
import java.util.*
...
या
/**
* Copyright ...
*/
import java.util.*
....
यह नहीं बल्कि वर्ष (लगभग 1999) सूर्य coding conventions दस्तावेज़ से पता चलता है /* */।
अधिक विशेष रूप से, यह आपके वर्ग/इंटरफेस फ़ाइल (फ़ाइलें) के लिए निम्नलिखित लेआउट पता चलता है:
शुरुआत टिप्पणी
/*
* 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 {
...
}
आप /** */ दस्तावेज़ीकृत उपकरणों का उपयोग अगर यह हड़पने जाएगा ताकि आप इसे :) का उपयोग कर बेहतर कर रहे हैं
मैं बस कुछ खुला स्रोत जावा परियोजनाओं पढ़ते हैं, वे सब मिल गया का उपयोग /* */
जावाडोक केवल /** ... */ टिप्पणियां इकट्ठा करेगा अगर वे सीधे किसी भी घोषणा प्रलेखित किया जाना से पहले। package (पैकेज-info.java के अलावा) और import घोषणाओं को किसी भी तरह से दस्तावेज नहीं किया गया है, इसलिए जावाडोक किसी भी तरह से टिप्पणी को नहीं देख पाएंगे।
चूंकि यह जावाडोक के लिए कोई फर्क नहीं पड़ता है, इसलिए आप "कम भारी" /* ... */ संस्करण का भी उपयोग कर सकते हैं।
+1 [यहां प्रलेखन संदर्भ है] (http://docs.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html#comments) यदि आप इसे अपने उत्तर में जोड़ना चाहते हैं। विशेष रूप से अनुभाग ** टिप्पणियों का प्लेसमेंट **, जहां यह कहता है: * "दस्तावेज़ीकरण टिप्पणियां केवल तभी पहचानी जाती हैं जब कक्षा, इंटरफ़ेस, कन्स्ट्रक्टर, विधि या फ़ील्ड घोषणाओं से पहले तुरंत रखा जाता है" *। यह इस प्रश्न पर चर्चा की भी पहचान करता है: * "एक आम गलती है कि कक्षा की टिप्पणी और कक्षा घोषणा के बीच 'आयात' कथन डालना है। इससे बचें, क्योंकि जावाडोक उपकरण कक्षा की टिप्पणी को अनदेखा कर देगा।" * –
क्या यह हमेशा सही बात है, यद्यपि? क्या होगा यदि कॉपीराइट केवल कोड पर लागू होता है? क्या होगा यदि जावाडोक एपीआई लाइसेंस प्राप्त/कॉपीराइट किया गया है? –
यह वास्तव में प्रश्न में दिए गए उदाहरण कोड के लिए गलत है। [Paŭlo का जवाब] देखें (http://stackoverflow.com/a/8323983/29995) और इस पर मेरी टिप्पणी। –
जावाडोक प्रश्न में उदाहरण जैसे आयात विवरण से पहले सामान नहीं लेगा। –