Помните, это всего лишь условности. Лучшая практика, конечно, но иногда вы вынуждены выходить за рамки. Самое главное, чтобы быть последовательным во всех и внутри ваших проектов.
ы вы посоветовали для хорошего шаблона сценария bash / ksh, который будет использоваться в качестве стандарта для всех вновь создаваемых сценариев?
Я обычно начинаю (после#! строка) с закомментированным заголовком с именем файла, кратким описанием, использованием, возвращаемыми значениями, автором (ами), журналом изменений и помещается в 80-символьные строки.
Все строки документации я начинаю с двойных символов## так что я могу легко их найти, а локальные имена переменных начинаются с "__".
Любые другие лучшие практики? Подсказки? Соглашения об именах? Как насчет кодов возврата?
Комментарии к управлению версиями: у нас все в порядке с SVN, но у другого отдела на предприятии есть отдельный репозиторий, и это их сценарий. Как мне узнать, с кем можно связаться с Q, если нет информации @author? Использование записей, похожих на javadocs, имеет смысл даже в контексте оболочки, IMHO, но я могу ошибаться.