. Ndi …

They may forget Ur Good deeds, Just do Good…

PHP for Lazy Programmer #4

leave a comment »

Menulis nama variable, function, class, table … dsb.

NAMA UNTUK VARIABLE
0. Biasakan nama dalam bahasa Inggris. Kalau anda menggunakan bahasa
Turki, kesulitannya adalah: pertama anda sulit membuat nama, kedua
anda sulit memahaminya, ketiga anda menyulitkan orang lain.

contoh:
$açýklama
$baþkanlarýmýz

baru mengetik, anda sudah kehilangan pekerjaan, karna anda nggak
menemukan character ç di keyboard anda.

1. Nama adalah sesuatu yang membuat kita mengenali, saling mengenal,
memulai perkenalan, dan membuat kita jadi ingat dan jadi lupa.

2. Namun berbeda dengan pemberian nama untuk anak, yang banyak
dijual bukunya, nama untuk elemen-elemen dalam bahasa pemrograman,
tidak dijual secara khusus dalam bentuk buku atau CD. Hanyasaja, di
setiap buku programming tingkat dasar, biasanya disajikan saran-
saran pemberian nama.

2. Prosedur pembuatan nama yang umum adalah:

a. buatlah nama yang singkat dan menjelaskan dirinya sendiri.

contoh:

$client
$customer

contoh buruk:

$clnt
$xyz
$dodol

b. konsistenlah dalam pemberian nama, dalam hal ini anda bisa
menciptakan aturan pemberian nama.

dalam aturan pemberian nama, berilah PREFIX untuk menandai kelompok-
kelompok variable.

sebagai contoh:
nama-nama varible yang berkaitan dengan client:

$clientname
$clientphone
$clientfax
$clientemail … dst.

dan konsisten!

contoh yang tidak konsisten:

$clientname
$client_phone
$clientFax
$ClientEmail

Keuntungan dengan konsistensi dalam pemberian nama adalah:

– jika anda bekerja di perusahaan, anda akan mudah mengelola code-
code programming yang dikerjakan oleh berbeda-beda orang
– jika anda freelancer, anda akan mudah mengelola code-code
programming yang anda kerjakan untuk berbagai client dari tahun ke
tahun

NAMA UNTUK FUNCTION
0. Aturan dasar penamaan variable berlaku disini. Namun untuk nama
function, anda nggak perlu peduli dengan hurup besar dan kecil,
nggak ada artinya membedakannya di php.

1. PHP sendiri hadir dengan cara pemberian nama yg kurang konsisten,
dimana ada nama yg menggunakan underscore dan ada juga yang nggak.

contoh:
nama-nama function berkaitan dg image, tidak menggunakan “_”
seperti: imagecolorat, imagejpeg, …

nama-nama function berkaitan dg swf, selalu diawal dg “swf_”
seperti: swf_actiongeturl, swf_actionstop, …

semenara nama-nama function yg berkaitan dg string tidak konsisten.

2. Namun demikian, anda sebaiknya konsisten dalam memberikan nama
function. Ikuti sedikit gaya penamaan seperti function2 untuk SWF,
yakni diawali dengan nama kelompok/kategori function diikuti
underscore, lalu diikuti dengan katakerja.

contoh:
thumbnail_create()
thumbnail_getsize()
thumbnail_resize() … dsb

Untuk nama-nama function di dalam ruang lingkup terbatas atau di
dalam sebuah CLASS, tidak perlu pake prefix.

NAMA CLASS
Konsensus penamaannya adalah menggunakan kata benda dan diawali
dengan hurup kapital.

NAMA TABLE
1. Ada yang membiasakan diri menamai table dengan prefix “tbl_”
atau “table_”, hal ini dimaksudkan untuk memudahkan mengenalinya
ketika menulis script yg melibatkan query. Namun hal seperti ini
tidak menjadi kenizcayaan.

2. Lebih penting lagi adalah ketika menamai field, usahakan
prefixnya adalah nama tablenya.

Contoh:
nama table: clients
nama fields: clientname, clientphone, clientfax, …

NAMA FIELD-FIELD FORM
1. Namai form anda dengan katakerja diikuti kata benda.

contoh: addclient, …

2. Namai field-field dengan prefix yg sesuai.

contoh: clientname, clientphone, clientfax, … dst

NAMA FILE
1. Mencari file di seribu tumpukan file dalam folder anda bukanlah
perkerjaan mudah. File akan mudah ditemukan kalo mempunyai ciri-ciri.

2. Sebaiknya, namai file-file anda seperti anda menamai function,
karena umumnya file-file anda adanya adalah karena melakukan suatu
proses.

Huda M Elmatsani

Written by ndi

March 26, 2009 at 8:17 pm

Posted in PHP

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s

%d bloggers like this: