Автор Тема: Оформлення прикладів коду на сайті  (Прочитано 676 раз)

Svinks

  • Newbie
  • *
  • Сообщений: 2
    • Просмотр профиля
Привіт. Читаю ваш сайт. Є один недолік. Приклади коду дуже нечитабельні, іде дуже багато часу на їх розуміння. Ось наприклад:
Цитировать
// Генерируется уникальный индекс для обращения к данному клиенту, если это
// ещё не было сделано на другой странице. О функции ssjs_generateClientID см.
// "Уникальное Обращение к Объекту client".
if client.id == null {
client.id = ssjs_generateClientID();
}
// Если пула для данного клиента ещё нет, он создаётся
// и производится его соединение с БД.
project.lock();
if (project.sharedPools[client.id] == null)
{
project.sharedPools[client.id] = new DbPool ("ORACLE",
"myserver", user, password, "", 5, false);
}
project.unlock();
// Для удобства устанавливается переменная для этого пула.
var clientPool = project.sharedPools[client.id];
// Теперь у Вас есть пул: посмотрим, соединён ли он. Если нет, попытаемся соединить его.
// Если это не удаётся, перенаправляем на специальную страницу,
// чтобы проинформировать пользователя.
project.lock();
if (!clientPool.connected()) {
clientPool.connect("ORACLE", "myserver", user, password,
"", 5, false);
if (!clientPool.connected()) {
delete project.sharedPools[client.id];
project.unlock();
redirect("noconnection.htm");
}
}
project.unlock();
// Если Вы дошли до этого места, Вы успешно соединились и
// можете работать с БД.
clientConn = clientPool.connection();
clientConn.SQLTable("select * from customers");
// ... другие операции с БД ...
// Всегда освобождайте соединение, если оно Вам больше не нужно.
clientConn.release();
}

Все зліплено до лівого краю, дуже негарно виглядає, відпадає бажання читати й розбиратися.
Рекомендую вам відформатувати всі приклади коду. Додати в них відступи і виділення кольорами окремих елементів тексту. Наприклад:
Цитировать
// Генерируется уникальный индекс для обращения к данному клиенту, если это
// ещё не было сделано на другой странице. О функции ssjs_generateClientID см.
// "Уникальное Обращение к Объекту client".

if client.id == null
{
   client.id = ssjs_generateClientID();
}

// Если пула для данного клиента ещё нет, он создаётся
// и производится его соединение с БД.

project.lock();
if (project.sharedPools[client.id] == null)
{
   project.sharedPools[client.id] = new DbPool ("ORACLE",   "myserver", user, password, "", 5, false);
}
project.unlock();

// Для удобства устанавливается переменная для этого пула.
var clientPool = project.sharedPools[client.id];
// Теперь у Вас есть пул: посмотрим, соединён ли он. Если нет, попытаемся соединить его.
// Если это не удаётся, перенаправляем на специальную страницу,
// чтобы проинформировать пользователя.

project.lock();
if (!clientPool.connected())
{
   clientPool.connect("ORACLE", "myserver", user, password, "", 5, false);
   if (!clientPool.connected())
   {
      delete project.sharedPools[client.id];
      project.unlock();
      redirect("noconnection.htm");
   }
}
project.unlock();

// Если Вы дошли до этого места, Вы успешно соединились и
// можете работать с БД.

clientConn = clientPool.connection();
clientConn.SQLTable("select * from customers");
// ... другие операции с БД ...
// Всегда освобождайте соединение, если оно Вам больше не нужно.

clientConn.release();

Хоча б так.

admin

  • Administrator
  • Newbie
  • *****
  • Сообщений: 25
    • Просмотр профиля
    • Email
Re: Оформлення прикладів коду на сайті
« Ответ #1 : Май 07, 2011, 11:28:40 pm »
Вітаю першого дописувача нашого форума!
Розумієте у чому справа.
Скачав колись цю доку років 5 тому та зробив сайт, який її показує.
Наліпив ще усякої реклами :-)
З тих пір усе працює в автономному режимі без усякої підтримки з мого боку.
Якщо подивитися на HTML код сторінки http://js-book.org.ua/servJSLW1.html (напевно Ви про цей урл казали),
то видно, що непросто одразу знайти рішення. Щоб за допомогою CSS якось оформити каменти, треба щоб вони були виділені якимись тегами, щоб можна було побудувати селектори CSS. А там у лістінгу код у перемішку з каментами.
Можна, звичайно, вручну... Або якийсь хитрий парсер зробити.
В мене поки бажання не виникало щось там покращувати.

Якщо Ви маєте час та бажання, можете доопрацювати матеріали. Я додам якісь ссилки "Подивитися альтернативний варіант", чи якось так. Вкажу під редакцією "Svinks" :-)

Взагалі щоб зробити гарний сайт для людей, треба постійно ним займатись, писати корисний унікальний контент.
Може колись дійдуть руки.

Svinks

  • Newbie
  • *
  • Сообщений: 2
    • Просмотр профиля
Re: Оформлення прикладів коду на сайті
« Ответ #2 : Май 08, 2011, 03:59:23 pm »
Нажаль в мене часу так само мало як і в вас.