8.х Хороший стиль

Тема в разделе "Общие вопросы "1С:Предприятие 8"", создана пользователем CSCO12103692, 20 ноя 2012.

  1. nbIpKuH_BaH9I
    Offline

    nbIpKuH_BaH9I Модераторы Команда форума Модератор

    Регистрация:
    16 сен 2009
    Сообщения:
    6.977
    Симпатии:
    397
    Баллы:
    104
    Стандарты конечно же есть. Но это скорее всего стандарты к составлению тех. задания в целом. Не только для 1С. А по-поводу справки - это уже скорее всего как правило хорошего тона. Лично Вы, можете писать код и т.д. как Вам заблагорассудится. Если посчитаете нужным, то пишите справку. Могу сказать лишь от себя, что по возможности стараюсь и справку писать и комменты к работе процедур и функций оставлять. Дабы не хочу, чтобы подле меня пришел человек и вспомнил меня не добрым словом. А справка иногда бывает очень полезной и для самого себя. Я недавно на работе с коллегами разрабатывали новый функционал. Так вот. Документов новых там предостаточно. А ведь еще есть и другие решения, которые также нуждаются в обслуживании. И бывает, что просто мозг забывает для каких целей предназначен документ. У меня, например, есть документы ЗапускДСЕ и ДСЕЗапуск. Когда не пользуешься ими пару месяцев, а потом надо, то уже и не вспомнишь что каждый и них делает.
  2. Svb
    Offline

    Svb Опытный в 1С Команда форума

    Регистрация:
    12 янв 2011
    Сообщения:
    980
    Симпатии:
    19
    Баллы:
    29
    Понятно. А стандарты эти где посмотреть? В гугле или есть более точный источник? :)
  3. nbIpKuH_BaH9I
    Offline

    nbIpKuH_BaH9I Модераторы Команда форума Модератор

    Регистрация:
    16 сен 2009
    Сообщения:
    6.977
    Симпатии:
    397
    Баллы:
    104
    По тех. заданию?! Я тоже искал недавно. Не смог найти определенного места. Так что гугл. И по кускам собирать. :)
  4. TopicStarter Overlay
    CSCO12103692
    Offline

    CSCO12103692 Опытный в 1С

    Регистрация:
    19 июн 2012
    Сообщения:
    190
    Симпатии:
    0
    Баллы:
    26
    Почитал статью на Хабре "Код CSS «с душком»". Хотя разговоры как правильно писать для веба, нашел для себя интересные моменты, например "магические числа". На вскидку вспомнил, что как минимум пару раз такое юзал в своем приложении((

    ....
    Магические числа


    Их я особенно ненавижу! Магическое число — это бессмысленное значение, которое используется потому, что оно «просто работает». Например:

    .site-nav{
    /* [styles] */
    }
    .site-nav > li:hover .dropdown{
    position:absolute;
    top:37px;
    left:0;
    }


    top:37px; — это магическое число. Единственная причина, по которой оно здесь — так получилось, что элементы списка имеют 37 пикселей в высоту, и выпадающие подменю должны появляться внизу элемента меню.

    Проблема в том, что эти 37 пикселей — чистая случайность, и на эту константу совершенно нельзя положиться. Что если кто-то изменит размер шрифта в пункте меню, и он будет иметь 29, а не 37 пикселей в высоту? Что если в Chrome пункт меню будет иметь 37 пикселей высоту, а в IE — 36? Это число работает только в одном конкретном случае.

    Никогда, никогда не используйте значения которые «просто работают». В предыдущем примере гораздо лучше было бы написать top:100%; вместо top:37px;

    И это не единственная проблема с магическими числами. Кроме ненадёжности они создают ещё и проблему коммуникации. Как другой разработчик сможет понять откуда взялось это число? Если ваш код больше и сложнее приведённого выше примера, и какое-то из магических чисел вдруг перестало работать, вы столкнётесь с тем, что:
    • другой разработчик, не зная, откуда взялось это число, будет вынужден писать правильный стиль для этого случая с нуля;
    • или же, если он очень осторожен, он оставит число на месте и попытается решить проблему, не трогая его. Таким образом кривой и некрасивый костыль рискует остаться в коде навечно и обрасти новыми костылями.

    Магические числа — это плохо. Они быстро устаревают, они мешают другим разработчикам, их нельзя объяснить и на них нельзя положиться.

    Нет ничего хуже, чем наткнуться на такое необъяснимое число в чужом коде. Зачем оно здесь? Что оно значит? Можно ли его трогать или не стоит? Я задаю эти вопросы всякий раз, как вижу такое число. И самый главный вопрос: «Как можно добиться такого же результата без магии?»

    Бегите от магических чисел как от чумы!
    .......

    Статья целиком
    http://habrahabr.ru/post/160177/
  5. nbIpKuH_BaH9I
    Offline

    nbIpKuH_BaH9I Модераторы Команда форума Модератор

    Регистрация:
    16 сен 2009
    Сообщения:
    6.977
    Симпатии:
    397
    Баллы:
    104
    Я с утра плохо догоняю. А как это относится к 1С?
  6. TopicStarter Overlay
    CSCO12103692
    Offline

    CSCO12103692 Опытный в 1С

    Регистрация:
    19 июн 2012
    Сообщения:
    190
    Симпатии:
    0
    Баллы:
    26
    Это относится к программированию в целом, а значит относится и к 1С. Кроме того, я же написал выше, что сам в 1С по незнанию использовал такие фишки.
    Например для разбора текстовых файлов.
  7. nbIpKuH_BaH9I
    Offline

    nbIpKuH_BaH9I Модераторы Команда форума Модератор

    Регистрация:
    16 сен 2009
    Сообщения:
    6.977
    Симпатии:
    397
    Баллы:
    104
    Ну ясно.
  8. TopicStarter Overlay
    CSCO12103692
    Offline

    CSCO12103692 Опытный в 1С

    Регистрация:
    19 июн 2012
    Сообщения:
    190
    Симпатии:
    0
    Баллы:
    26
    В продолжение темы набрел на весьма интересную статью о культуре программирования:
    http://habrahabr.ru/post/166113/

    А так же конкретные рекомендации:
    ftp://ftp.idsoftware.com/idstuff/doom3/source/CodeStyleConventions.doc

    Там идет разбор очень больших проектов.

    зы
    Хоть это и не 1С, но, думаю, общие правила верны.

Поделиться этой страницей