11
मुझे लगता है कि जैसे मेरे व्यापार तर्क के अंदर टिप्पणियों का एक बहुत लिखा है:क्या जावाडोक टूल विधियों के अंदर टिप्पणियों को पहचानता है?
/**
* Do some important stuff.
* @param pDog
* @param pAllDogTraining
* @return
*/
@Overwrite
public Map<DogId, Dog> doEvaluateAllDog(final Dog pDog, final Collection<DogTraining> pAllDogTraining) {
final Map<DogId, Dog> lAllDogBad = new HashMap<DogId, Dog>();
final List<DogTraining> lAllDogTraining = new ArrayList<DogTraining>(pAllDogTraining);
/**
* Remove deleted entries.
* Detailed description
*/
removeDeletetTrainings(lAllDogTraining);
/**
* Set the priority for each training
* - bad dogs
* - nice dogs
* - unknown dogs
* Detailed description
*/
Collections.sort(lAllDogTraining, new DogTrainingComparator());
// Iterate over training elements and set the conflict state
for(.....
मेरा प्रश्न, javadoc उपकरण भी पहचान करता है मेरी विधि ब्लॉक के अंदर दस्तावेज़ टिप्पणी? निकट भविष्य में हम एक तकनीकी दस्तावेज पेश करेंगे और हमारी परियोजना का जावाडॉक इसका हिस्सा होगा।
एक विधि के अंदर टिप्पणियां आमतौर पर दस्तावेज़ीकरण विवरण दस्तावेज करती हैं। जावाडॉक को वर्ग/विधि के इंटरफेस (एपीआई) का वर्णन करना चाहिए। तो यह दो अलग-अलग चीजें हैं जिन्हें किसी भी तरह मिश्रित नहीं किया जाना चाहिए। – NilsH