• Как сделать документацию к коду?

    @kn0ckn0ck
    Продюсер
    Есть две крайности, которых лучше избегать:
    1. красивая и исчерпывающая документация требует колоссальных ресурсов на поддержку
    2. сложно воспринимаемый код, без малейших подсказок с чего все начинается и чем заканчивается

    Стандартные решения:
    1. самодокументируемый код, составленный так, что читающий может понять что для чего и в какой последовательности работает.
    2. описание интерфейсов (назначение метода, тип/суть параметров и т.п.) в форме комментов в коде.
    3. автоматическая документация (генерится из комментариев) - эффективно, только если сам код закрыт.
    4. модульные тесты, фиксирующие требования к коду и демонстрирующие его использование.
    5. описание высокоуровневого дизайна (High Level Design, HLD), описывающий какие элементы существуют, их взаимосвязь друг с другом и основные сценарии взаимодействия.

    Работающая документация - это компромисс из этих практик, релевантный конкретной ситуации.

    Кстати, проектная работа, это не только документация к коду, это еще и свод правил, которые позволят архитектуре не расползтись кто в лес кто по дрова, а также сохранят стилистику написания кода для единообразия и легкой поддерживаемости кода.
    Ответ написан
    12 комментариев
  • Как вы разрабатываете свои приложения?

    Robur
    @Robur
    Знаю больше чем это необходимо
    Я тут предполагаю что вы хотите сделать какой-то стоящий продукт, который кому-то нужен:

    Вас посетила очередная идея на миллиард. Вы полны решимости осуществить проект, но пока, кроме абстрактной идеи, ничего нет. Ваши действия?

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

    Если сильно верите в какую-то идею, для начала - валидируете.

    понимаешь, что нихрена не понимаешь - нет представления, какие элементы на самом деле должны быть на данной странице.

    Тут вы почти уловили суть. Ваша "идея" вам должна говорить, какие элементы нужны, зачем они нужны и почему именно их надо делать прямо вот сейчас а не что-то другое. Пока этого нет - у вас не идея а какая-то смутная фантазия, вы не знаете что делаете, и вряд ли что-то сделаете.

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

    Тут вариантов два - найти кофаундера который будет двигать эту сторону, а себе оставить реализацию, либо пересилить себя и научиться нужным скиллам.
    Ответ написан
    2 комментария
  • Как подбирать курсовой проект для IT-учеников?

    xmoonlight
    @xmoonlight
    https://sitecoder.blogspot.com
    Если цель курсовой - обучение: ставьте ту задачу, результат которой ученик потом сможет использовать для оптимизации своей работы в дальнейшем (я говорю о рекурсивных методах разработки).

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

    web-verzus-team
    @web-verzus-team
    Full Stack Developer
    <a href="javascript:void(0)"> </a>
    Ответ написан
    Комментировать
  • Как сделать ссылку, которая не перезагружает страницу?

    @dixoNich
    frontend developer
    Повесить обработчик и отменить действие браузера.
    $('a').on('click', function (e) { e.preventDefault() })
    Ответ написан
    Комментировать
  • Как сделать ссылку, которая не перезагружает страницу?

    @entermix
    <a href="" onclick="return false;"> </a>
    Ответ написан
    Комментировать