Как кто комментирует код при разработке и тестировании

[solovin1986]

Только не ругайте мой вариант такой

//*///поиск и удаление ... >

if ($a == $b) {

}else{

}

//*///поиск и удаление ... <

//*///поиск и удаление ...> - при удалении первого слэша все попадает в коммент

> - начинаем код

< - заканчиваем код

Edited October 27, 2009 by solovin1986

[Иван Шумов]

/*
описание класса бла-бла-бла
*/

class blablabla()
{
...
}

/*
на этом сегодня закончим, задолбало
*/

[gesandte]

# коммент

[AMD]

/*
на этом сегодня закончим, задолбало
*/

Убрать фтопку.

Не забываем про документирование кода.

	  /** 
	* Соеденение с базой данных MySQL. 
	* Метод устанавливает соеденение,  
	* выбирает БД, устанавливает нужную кодировку. 
	*  
	* @access public 
	* @param void 
	* @return void 
	* @todo забыл сделать кодировку тырыпыры )
	*/	

	 public function connect() { }

Edited October 27, 2009 by AMD

[Int]

//Класс Тут был Вася

interface _vasya
{
	public function Vasya();   //Вася делает ку
}

class vasya implements _vasya
{
	public function Vasya()
	{
		echo 'ку';
		$realKU=Hitrovidelannayafunkcia();  //Поулчаем правильный ку
	}
}

Edited October 27, 2009 by Int

[AMD]

ФТОПКУ ИНТЕРФЕЙСЫ!!11

Назер они вообще нужны? тормозят только пыху

[Fenix]

ФТОПКУ ИНТЕРФЕЙСЫ!!11

Назер они вообще нужны? тормозят только пыху

Я тоже сначала так думал. Потом понял, зачем они нужны.

Коментирую код так:

// Короткая заметка

/* Заголовок:
   коментирую
   коментирую
   коментирую
   коментирую
*/

[xPoint]

вообще то по-разному, в зависимости от ситуации и настроения.

Но чаще всего стараюсь вставлять комменты в формате phpdoc, если это возможно.

[Fenix]

вообще то по-разному, в зависимости от ситуации и настроения.

Но чаще всего стараюсь вставлять комменты в формате phpdoc, если это возможно.

Почитаю, что это такое. Это, как я понимаю phpDocumentor?

[AMD]

ага, клевая штука.

Когда приходится документировать API для других сотрудников, спасает именно он.

[Fenix]

ага, клевая штука.

Когда приходится документировать API для других сотрудников, спасает именно он.

Я час читаю класную книгу. Всем советую. "PHP. Объекты, шаблоны и методики программирования". Автор - Мэтт Зандстра. Так есть глава про эту штуку. И до неё уже недалеко.

[AMD]

Отличная книга.

Мне на нее тогда 200 рублей не хватило

[Fenix]

Отличная книга.

Мне на нее тогда 200 рублей не хватило

А сейчас? Заказать же можно без проблем.

[AMD]

Отложил на озоне.

Думаю куплю еще обязательно.

[EGORR]

http://www.williamspublishing.com/PDF/978-...1586-3/part.pdf

Замануха от издательства.

[Fenix]

http://www.williamspublishing.com/PDF/978-...1586-3/part.pdf

Замануха от издательства.

В чем?

[EGORR]

Да ни в чем. Просто дают скачать главу из книги. И файлы с примерами из книги.

[Fenix]

Да ни в чем. Просто дают скачать главу из книги. И файлы с примерами из книги.

Они дали главу, чтоб покупатель мог почитать немного эту книгу. Узнать, какой язык у автора. А то закажешь какую-нибудь книгу, и только когда получишь книгу, оказывается что ты непонимаешь язык автора. А так можно узнать, как читается. Понятно ли написано, или нет.

[keltanas]

Только формат phpDocumentor. Т.к. при разработке пользуюсь эклипсом, другой формат комментариев просто уже не приемлем.

Это, что касается описания классов, методов, функций.

А одну строку чтобы пояснить, можно и // использовать

# - это вообще в топку, только мешать будет