Как правильно вести документацию к большому проекту на php? поделитесь опытом

@-MaZaHaKa- · Регистрация: 30.09.2013

Студворк — интернет-сервис помощи студентам

Проблема такова: В целях изучения ООП начал писать сайт с нуля, уже есть роутинг, вызов контроллера и нужного экшена, подключил шаблон. Проект начинает обрастать кодом, и уследить за каждым концом кода становится всё сложнее.

Подскажите велосипед (способ) который позволит максимально просто писать код и не путаться в нем? Я не знаю, может есть какие-то способы построения схем не только для участков кода, а и для проекта в целом?

Спасибо за помощь

@Блеф · 10.09.2014, 18:31

Что бы не путаться в коде нужно его грамотно писать, сначала хорошо продумать конструкцию.
Для комментирования используйте phpDoc к примеру перед каждым методом (функцией) делайте комментарий такого вида. И даже если забудете как работает она, то вспомнить не составит труда.
Пример

PHP
1
2
3
4
5
6
7
8
9
10
/**
* Функция достает все данные с таблицы "new"
* @var category - номер  категории
* return array()
/*
function getAll($category)
{
 //реализация
return $array;
}

http://omurashov.ru/docblock-in-php-documentation/
http://habrahabr.ru/sandbox/22836/
http://lifeexample.ru/razrabot... entor.html

Почти во всех IDE есть специальная подсветка для этого стандарта коментирования

Новые блоги и статьи Все статьи Все блоги /
Инструменты COM: Сохранение данный из VARIANT в файл и загрузка из файла в VARIANT bedvit 28.01.2026 Сохранение базовых типов COM и массивов (одномерных или двухмерных) любой вложенности (деревья) в файл, с возможностью выбора алгоритмов сжатия и шифрования. Часть библиотеки BedvitCOM Использованы. . .	Загрузка PNG с альфа-каналом на SDL3 для Android: с помощью SDL_LoadPNG (без SDL3_image) 8Observer8 28.01.2026 Содержание блога SDL3 имеет собственные средства для загрузки и отображения PNG-файлов с альфа-каналом и базовой работы с ними. В этой инструкции используется функция SDL_LoadPNG(), которая. . .	Загрузка PNG с альфа-каналом на SDL3 для Android: с помощью SDL3_image 8Observer8 27.01.2026 Содержание блога SDL3_image - это библиотека для загрузки и работы с изображениями. Эта пошаговая инструкция покажет, как загрузить и вывести на экран смартфона картинку с альфа-каналом, то есть с. . .	Влияние грибов на сукцессию anaschu 26.01.2026 Бифуркационные изменения массы гриба происходят тогда, когда мы уменьшаем массу компоста в 10 раз, а скорость прироста биомассы уменьшаем в три раза. Скорость прироста биомассы может уменьшаться за. . .
Воспроизведение звукового файла с помощью SDL3_mixer при касании экрана Android 8Observer8 26.01.2026 Содержание блога SDL3_mixer - это библиотека я для воспроизведения аудио. В отличие от инструкции по добавлению текста код по проигрыванию звука уже содержится в шаблоне примера. Нужно только. . .	Установка Android SDK, NDK, JDK, CMake и т.д. 8Observer8 25.01.2026 Содержание блога Перейдите по ссылке: https:/ / developer. android. com/ studio и в самом низу страницы кликните по архиву "commandlinetools-win-xxxxxx_latest. zip" Извлеките архив и вы увидите. . .	Вывод текста со шрифтом TTF на Android с помощью библиотеки SDL3_ttf 8Observer8 25.01.2026 Содержание блога Если у вас не установлены Android SDK, NDK, JDK, и т. д. то сделайте это по следующей инструкции: Установка Android SDK, NDK, JDK, CMake и т. д. Сборка примера Скачайте. . .	Использование SDL3-callbacks вместо функции main() на Android, Desktop и WebAssembly 8Observer8 24.01.2026 Содержание блога Если вы откроете примеры для начинающих на официальном репозитории SDL3 в папке: examples, то вы увидите, что все примеры используют следующие четыре обязательные функции, а. . .

@-MaZaHaKa- 21 / 21 / 16 Регистрация: 30.09.2013 Сообщений: 262

	Как правильно вести документацию к большому проекту на php? поделитесь опытом 10.09.2014, 16:55. Показов 1977. Ответов 1 Метки нет (Все метки) Проблема такова: В целях изучения ООП начал писать сайт с нуля, уже есть роутинг, вызов контроллера и нужного экшена, подключил шаблон. Проект начинает обрастать кодом, и уследить за каждым концом кода становится всё сложнее. Подскажите велосипед (способ) который позволит максимально просто писать код и не путаться в нем? Я не знаю, может есть какие-то способы построения схем не только для участков кода, а и для проекта в целом? Спасибо за помощь 0

Как правильно вести документацию к большому проекту на php? поделитесь опытом

Решение