اعلام یک حاشیه نگاری برای نوع

بسیاری از حاشیه نگاری ها می توانند جایگزین کامنت های ما در کدها باشند. فرض کنید که یک گروه نرم افزاری تعریف هر یک از کلاس های خود را با کامنت های زیر شروع می کند :

public class Generation3List extends Generation2List {

// Author: Mostafa Davodi

// Date: 3/9/2017

// Current revision: 6

// Last modified: 4/4/2017

// By Mostafa Davodi

// Reviewers: Mostafa, Ali, Mohammad

// Class code goes here

}

برای اضافه کردن متادیتاهایی همچون اطلاعاتی که در بالا مطرح شد، ابتدا باید یک حاشیه نگاری نوع تعریف کرد. سینتکس این کار به شکل زیر است :

@interface ClassPreamble {

String author();

String date();

int currentRevision() default 1;

String lastModified() default “N/A”;

String lastModifiedBy() default “N/A”;

// Note use of array

String[] reviewers();

}

حال برای استفاده از حاشیه نگاری تعریف شده در قسمت قبل حین تعریف یک کلاس بصورت زیر عمل می کنیم : 

@ClassPreamble (

author = “Mostafa Davodi”,

date = “3/9/2017”,

currentRevision = 6,

lastModified = “3/3/2017”,

lastModifiedBy = “Mostafa Davodi”,

// Note array notation 

reviewers = {“Mostafa”, “ali”, “Mohammad”}

)

public class Generation3List extends Generation2List {

// class code goes here

}

حال برای آنکه اطلاعات حاشیه نگاری ایجاد شده در داکیومنت های تولید شده توسط Javadoc نیز بیاید باید annotation مربوط به آن را نیز استفاده کنیم :

// import this to use @Documented

import java.lang.annotation.*;

@Documented

@interface ClassPreamble {

// Annotation element definitions

}