Kodlar Arasına Yorum Yazmak
Haziran 13, 2008 tarihinde Web Tasarım kategorisine eklendi | 1 yorum
Hangi programlama dilini kullanırsanız kullanın, yazılan kodlar arasına çeşitli yorumlar yazmak işleri fazlasıyla kolaylaştırır. Sayfanın hangi bölümünde ne tür işlemler yapılıyor, bu işlemler nerede bitiyor, kullanılan metod için kısa açıklamalar, aktif olmayan ancak açıklama etiketlerini kaldırarak kullanılabilcek kod grupları vs…
Kodlar arasına yazılan yorumlar için herkes kendine göre farklı metodlar kullanır. Bende oldukça fazla denemenin ardından standart yorum yazma şeklimi oluşturdum. Yazıda bahsetmek istediğim sadece kendime ait yorum yazma şeklinden ibaret değil, farklı sistemlerden toparladığım yorum yazma şekillerinide aktaracağım. Henüz bir standardınız yoksa bunlar belki fikir verebilir. Burada olmayan kullanımı kolay metodlarınızıda yorumlarınız ile paylaşabilirsiniz.
Öncelikle birkaç programlama dili veya teknolojisi için yorum yazma etiketlerine gözatalım;
HTML KODLARI ARASINA YORUM YAZMA
<!– Yorumlarınız –>
CSS KODLARI ARASINA YORUM YAZMA
/* Yorumlarınız */
PHP KODLARI ARASINA YORUM YAZMA
// Kısa notlarınız için
/*
Uzun notlarınız için
*/
ASP KODLARI ARASINA YORUM YAZMA
‘ Yorumlarınız
‘ Yorumlarınız
JAVASCRIPT KODLARI ARASINA YORUM YAZMA
// Kısa notlar
/*
Uzun notlar
*/
Evet, yorum yazma şekilleri bazı diller için yukarıdaki gibi. Yazdığım kodlar arasında (PHP ve CSS için) benim kullandığım kendimce standart haline getirdiğim şekiller ise aşağıdaki gibi;
PHP
// Kısa yorumlar
/* — Önemli bölümler için başlangıçlar ————————————- */
/**
* uzun notlar
* açıklama.
* açıklama.
*/
/** —————————————————————————-
* Sayfa başlıkları
* Copyright 2007 © Taylan … All rights reserved.
* Author: Taylan Aktepe- http://www.taylanaktepe.com
* klasor/dosya.php (20 May 2008)
—————————————————————————- **/
CSS
/* SAYFA BAŞLANGICI ——————————————————
Açıklama, açıklama açıklama */
/* Stil grupları: menu, ust, alt vs… (içindekiler, haber metni, slider vs.) */
Evet benim kullanmış olduğum yorum metodları kısaca bunlar. Diğer bazı hazır sistemlerde dikkatimi çekenler, kullanışlı olduğunu düşündüklerim;
SMF FORUM
WORDPRESS
// ** MySQL ayarları ** //
// Accepts matches array from preg_replace_callback in wpautop()
// or a string
PhpBB
/**
*
* @package phpBB3
* @version $Id: faq.php 8479 2008-03-29 00:22:48Z naderman $
* @copyright (c) 2005 phpBB Group
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*
*/
MyBB
/**
* MyBB 1.2
* Copyright © 2006 MyBB Group, All Rights Reserved
*
* Website: http://www.mybboard.net
* License: http://www.mybboard.net/eula.html
*
* $Id: index.php 3595 2008-01-09 00:10:57Z Tikitiki $
*/
4IMAGES
/* —————————— THE END ——————————- */
Bu yazının Popülerliği: 44% [?]
Yorumlar
1 yorum , “Kodlar Arasına Yorum Yazmak”
Yorum Yapın
phpbb3 seo…