Tujuan dari standar penulisan kode adalah untuk mencapai standarisasi dalam proses pengkodean dan mengembangkan kebiasaan perilaku yang baik untuk pengembangan program di masa depan.
Lingkup penggunaan spesifikasi penulisan kode: pengembangan proyek J2EE.
Konvensi penamaan paket:
Tujuan: Konvensi penamaan paket harus mencerminkan pembagian sumber daya proyek yang baik
Konvensi penamaan untuk paket dimana kelas servlet berada: nama perusahaan.nama grup pengembangan.nama proyek.web.servlet
Misalnya: net.linkcn.web.servlet
Konvensi penamaan untuk paket tempat kelas tag khusus berada: nama perusahaan.nama grup pengembangan.nama proyek.web.tags
Misalnya: net.linkcn.web.tags
Konvensi penamaan untuk paket tempat kelas filter berada: nama perusahaan.nama grup pengembangan.nama proyek.web.filter
Misalnya: net.linkcn.web.filter
Konvensi penamaan untuk paket tempat kelas Action berada: nama perusahaan.nama grup pengembangan.nama proyek.web.struts.action
Misalnya: net.linkcn.web.struts.action
Konvensi penamaan untuk paket dimana kelas ActionForm berada: nama perusahaan.nama grup pengembangan.nama proyek.web.struts.form
Misalnya: net.linkcn.web.struts.form
Konvensi penamaan paket Javabean: nama perusahaan. nama grup pengembangan
Misalnya: net.linkcn.web.service.impl
Konvensi penamaan antarmuka implementasi Javabean: nama perusahaan. Nama grup pengembangan. Nama proyek.web.layanan
Misalnya: net.linkcn.web.service
Konvensi penamaan untuk paket tempat kelas DAO berada: nama perusahaan.nama grup pengembangan.nama proyek.dao.impl
Misalnya: net.linkcn.dao.impl
Antarmuka yang diimplementasikan oleh kelas DAO memiliki konvensi penamaan dalam paket: nama perusahaan.nama grup pengembangan.nama proyek.dao
Misalnya: net.linkcn.dao
Konvensi penamaan untuk paket tempat kelas POJO dan file hbm berada: nama grup pengembangan nama.dao.hbm
Misalnya: net.linkcn.dao.hbm
Konvensi penamaan untuk paket tempat kelas publik global dan kelas antarmuka berada: nama perusahaan. Nama grup pengembangan. Nama proyek.global
Misalnya: net.linkcn.global
Konvensi penamaan untuk paket tempat kelas alat global berada: nama perusahaan.nama grup pengembangan.nama proyek.util
Misalnya: net.linkcn.util
Konvensi penamaan kelas Konvensi penamaan dasar:
Konvensi penamaan kelas dan antarmuka: dimulai dengan huruf kapital. Jika ada beberapa kata, gunakan huruf kapital pada huruf pertama setiap kata
Konvensi penamaan antarmuka: dimulai dengan huruf kapital "I", jika ada beberapa kata, gunakan huruf kapital pada huruf pertama setiap kata Misalnya: IStudentInfo
Penamaan kelas implementasi antarmuka:
Konvensi penamaan: Hapus huruf pertama "I" dari nama antarmuka yang diimplementasikan dan diakhiri dengan "Impl". Jika ada beberapa kata, gunakan huruf besar pada huruf pertama setiap kata.
Misalnya: StudentInfoImpl
Konvensi penamaan kerangka kerja J2EE+SSH
penamaan kelas servlet:
Konvensi penamaan: diakhiri dengan kata Servlet. Misalnya: LoginServlet
Penamaan POJO:
Cukup gunakan kelas yang dihasilkan secara otomatis oleh hibernasi
Penamaan kelas DAO:
Cukup gunakan kelas yang dihasilkan secara otomatis oleh hibernasi
Penamaan kelas tindakan:
Konvensi penamaan: Penamaan tindakan didasarkan pada nama POJO, nama POJO Aksi
Misalnya:
Nama POJO adalah Diary, dan tindakan terkaitnya adalah DiaryAction.
Penamaan kelas ActionForm:
Konvensi penamaan: Penamaan ActionForm ditentukan oleh nama POJO, dan nama POJO Form
Misalnya:
Nama POJO adalah Diary, dan actioForm yang terkait adalah DiaryForm
Penamaan antarmuka logika bisnis:
Konvensi penamaan: Penamaan antarmuka logika bisnis ditentukan oleh nama POJO, dan nama IPOJO adalah Layanan
Misalnya:
Nama POJO adalah Diary, dan antarmuka logika bisnisnya adalah IDiaryService.
Penamaan kelas implementasi logika bisnis:
Konvensi penamaan: Penamaan kelas implementasi antarmuka logika bisnis didasarkan pada nama POJO.
POJO diberi nama Diary, dan kelas implementasi antarmuka logika bisnis yang sesuai diberi nama DiaryServiceImpl.
Penamaan variabel kelas:
Konvensi penamaan: Huruf pertama dari nama variabel harus huruf kecil. Jika nama variabel terdiri dari beberapa kata, huruf pertama dari kata berikutnya harus menggunakan huruf kapital. Jangan gunakan "_" untuk menghubungkan kata-kata tersebut nama variabel harus bersifat pribadi. Anda dapat menambahkan metode penyetel dan pengambil.
Misalnya: private int studentAge;
int publik getStudentAge()
{
kembalinya siswaUsia;
}
public void setStudentAge(int studentAge)
{
this.Umur Pelajar=Umur Pelajar;
}
Penamaan konstan:
Konvensi penamaan: Semua huruf menggunakan huruf kapital. Jika ada beberapa kata, kata-katanya harus dipisahkan dengan "_". Dan variabelnya harus bertipe public, static, final. Misalnya: public static final String USER_NAME=”userName”;
Konvensi penamaan metode: huruf pertama harus huruf kecil. Jika nama variabel terdiri dari beberapa kata, huruf pertama dari kata berikutnya harus menggunakan huruf kapital. Jangan gunakan kata benda untuk kata-kata.
Misalnya: public int checkLogin(Nama string,String pwd){}
Spesifikasi anotasi: Spesifikasi anotasi adalah komponen terpenting dari keseluruhan spesifikasi pengembangan dan harus diterapkan secara ketat.
Catatan kelas:
Fungsi: Memberi anotasi pada seluruh kelas dan menguraikan secara singkat fungsi kelas.
Konvensi penulisan: Anotasi kelas harus ditulis sebelum sintaks deklarasi kelas. Di komentar, jelaskan fungsi dasar kelas, penulis, tanggal, versi, nama perusahaan, dan pernyataan hak cipta.
Format:
/* *
*Deskripsi fungsi kelas : (mendeskripsikan secara kasar fungsi kelas)
* @penulis: nama penulis
*
* @version : Nomor versi file kelas dimulai dari 1.0 (tentukan sendiri penambahan dan perubahan nomor versinya
* Situasi), status modifikasi (waktu modifikasi, penulis, status modifikasi)
*
* @lihat nama paket. Nama kelas referensi (daftar kelas induk, perkenalkan kelas, setiap kelas menempati satu baris), jika ada
*dapat dihilangkan
* Data yang relevan seperti: (untuk memudahkan pemahaman tentang beberapa data konstan kelas ini dan format beberapa data
*Atau data yang dianggap penting, bila tidak tersedia dapat dihilangkan)
*/
Sintaks deklarasi kelas adalah sebagai berikut:
/**
*
Judul:Kelas pemrosesan data modul Administrator
*
Deskripsi: Tambahkan dua angka
*
Hak Cipta: Hak Cipta (c) 2007
*
Perusahaan:Perusahaan Perangkat Lunak Huateng
*
* @penulis Tong Jinhu
*
* @version $Revisi: 1,7 $ $Tanggal: 2007/07/08$
*/
AdminDAO kelas publik
Komentar variabel dan konstan:
Fungsi: Jelaskan secara singkat arti dari variabel ini.
Standar Penulisan: Komentar variabel harus ditulis sebelum definisi variabel, dengan menjelaskan secara singkat maknanya.
Format:
/**
* Deskripsi fungsi variabel : (menjelaskan secara kasar fungsi variabel)
*/
Misalnya:
/**
*Tentukan variabel usia
*/
usia publik;
Komentar metode:
Fungsi: Penjelasan singkat tentang fungsi metode, anotasi tentang arti parameternya, dan nilai yang dikembalikan.
Konvensi penulisan: Komentar metode harus ditulis sebelum definisi metode. Anotasinya meliputi: penjelasan singkat tentang fungsi metode, penjelasan singkat tentang parameter metode, jenis nilai kembalian, dan arti nilai kembalian.
Format:
/**
*Deskripsi fungsi metode
* @param args (tipe parameter dapat ditulis setelah parameter, atau dapat dihilangkan
* Dihilangkan. Setiap parameter menempati satu baris)
* @return parameter keluaran (beberapa situasi ditulis pada baris yang sama)
* @lihat metode kelas #referensi (metode yang terkait dengan pemanggilan metode ini adalah untuk referensi
* Untuk ujian, tidak perlu mencantumkan setiap metode secara lengkap. Anda harus memilih metode yang bermakna.
*Metode menempati satu baris)
* @Exception kelas penanganan pengecualian (pengecualian yang dapat diberikan dalam metode, masing-masing
*Pengecualian menempati satu baris)
*/
Misalnya:
/**
* Ubah kata sandi administrator
* Nomor administrator @param adminId
* @param oldPassword kata sandi lama
* @kata sandi param kata sandi baru
* @return boolean apakah pengeditan berhasil
* @melempar UserException
* @melempar ServiceException
*/
public booleanitAdminPassword(int adminId,String Kata Sandi lama,
Kata sandi string) menampilkan UserException,ServiceException;
Penamaan halaman jsp:
Konvensi penamaan: Nama halaman jsp harus dimulai dengan huruf kecil. Jika terdiri dari beberapa kata, kata berikutnya harus dimulai dengan huruf besar. Nama harus mencerminkan arti halaman dan sebaiknya dikaitkan dengan nama modul.
Misalnya:
login.jsp --Halaman masuk
register.jsp --Halaman pendaftaran
message.jsp --Halaman pesan pelanggan
Spesifikasi organisasi folder proyek proyek J2EE:
Tujuan: Untuk membakukan bentuk pengorganisasian sumber daya aplikasi web siswa dan membentuk kebiasaan pengorganisasian file yang baik. Organisasi dokumen harus mencerminkan pembagian ke dalam modul.
Menurut karakteristik alat gerhana, struktur direktori proyek adalah:
src
---- Penyimpanan file java
Akar Web
|--images --menyimpan gambar publik yang diperlukan oleh program web
|--css -- menyimpan style sheet publik yang diperlukan oleh program web
|--js --Menyimpan file js publik yang diperlukan oleh program web
|--commons --menyimpan file publik yang diperlukan oleh program web
|--Folder modul fungsi (untuk menyimpan sumber daya yang terkait dengan modul fungsi tertentu)
|--images --menyimpan gambar yang terkait dengan modul fungsi ini
|--css --Menyimpan file style sheet yang terkait dengan modul ini
|--js --Menyimpan file js yang terkait dengan modul ini
|--jsp, halaman html
|--WEB-INF
|--kelas
|--lib
|--tld mengajukan
Spesifikasi penyerahan proyek J2EE Ketika proyek selesai, proyek harus diserahkan kepada pengguna sebagai sebuah produk.Spesifikasi organisasi proyek yang baik memungkinkan pengguna dengan mudah menemukan sumber daya yang dibutuhkan untuk proyek tersebut, dan juga merupakan cerminan profesionalisme perusahaan. Saat mengirimkan proyek, proyek harus diserahkan dalam format file berikut.
Folder utama proyek:
Fungsi: Menyimpan file sumber daya proyek lainnya.
Konvensi penamaan: time_class number_group X.
Misalnya: 070706_GS2T18_Grup 4.
Folder utama proyek mencakup folder dan file berikut:
|--src: Simpan file .java.
|--database: Menyimpan file skrip atau file cadangan database dari database.
|--source: Simpan semua file di direktori WebRoot di proyek gerhana.
|--depend : Menyimpan file jar lain yang harus diandalkan untuk mengkompilasi program.
|--javadoc: Simpan dokumentasi api javadoc yang dihasilkan oleh semua kelas.
|--war: arsipkan file untuk menyimpan program
|--xx.war: File proyek telah dipaketkan dan dapat langsung dijalankan.
|--project: Menyimpan kode teknik asli dan file proyek pengembangan.
|--Manual produk.doc: Menunjukkan cara menggunakan produk dalam gambar dan teks.
|--build.xml: skrip semut, digunakan untuk menghasilkan file perang yang sedang berjalan.
|--Penjelasan proyek.ppt: ppt untuk penjelasan proyek (ppt hanya untuk digunakan dalam proyek simulasi sekolah dan bukan untuk tujuan komersial lainnya)
Catatan: Dalam proyek yang lengkap, database harus memiliki sejumlah data pengujian yang valid untuk mendukung pengoperasian program.