2 Я новичок в AutoIt, но из чтения других справок знаю, что необязательные параметры в строке синтаксиса общепринято указывать в квадратных скобках. А если новичок этого не знает, то этот "штакетник" из квадратных скобок делает эту строку для него непонятной. Объяснения этих квадратных скобок я не встретил в справке. :(InputBox ( "title", "prompt" [, "default" [, "password char" [, width [, height [, left [, top [, timeout [, hwnd]]]]]]]] )
Выделенное жирным и расположенное в начале строки слово [опционально] отвлекает от описания и мешает его читать. Это слово нужно перенести в конец описания и убрать жирность (можно заменить ее на курсив)width [опционально] ширина окна.
height [опционально] высота окна.
Это будет понятно и не будет занимать много места в таблице.* Параметры, указанные в строке синтаксиса команды в квадратных скобках, является необязательными и могут отсутствовать в строке команды.
Если новичку надо к чему то привыкать, то уж точно не к сокращениям и каким-то англо-словам, а к метке как я предлагал [?]. Это всего лишь символьная метка. Я не читаю слова, мне достаточно увидеть жирное пятно, которое я хотел уменьшить для удобства чтения. Так что если мы голосуем за символьную метку, так голосуем либо за мой вариант либо за вариант предложенный CreatoR'ом. Иначе голоса делятся либо на два варианта с одинаковым рейтингом, либо голоса за символьную метку распадаются на подварианты и проирывают.gregaz сказал(а):По мне новичку лучше сразу привыкать к общепринятым понятиям :
Не переводя достойными заменами сделаем справку, которая создаёт больше вопросов, чем ответов.Не стоит стремиться перевести все слова.Так можно дойти до абсурда.
Да, это слово моднее звучит, чем "необязательный", как например "тенденция, моветон, амплуа, апофеоз". Поэтому оно придаёт справке солидность в ущерб пониманию.+ за опционально.
Мы приватно обсуждали этот вопрос, но скажу здесь почему я не согласен. Конец каждой строки не имеет постоянной позиции и неудобно выискивать эту метку, в крайнем случае добавить колонку в конце таблицы, но опять же колонка займёт ширину в том числе и у обязательных параметров.Это слово нужно перенести в конец описания и убрать жирность (можно заменить ее на курсив)
опять же выискивать звёздочку.4 Как вариант можно заменить это слово, вместе с квадратными скобками, на звездочку и в Примечании написать:
Да, у некоторых функций не указано что должен содержать параметр если его требуется игнорировать. UDF в этом плане намного проще, там параметры указаны сразу в синтаксической строке функции, или в любом случаем можно заглянуть в сам UDF. Думаю такие функции нужно отписывать здесь и на офсайте, чтобы документировать.5 У новичка больше вопросов может вызвать, как записать команду, если ему нужно указать один из "необязательных" параметров, а остальные, стоящие левее, "необязательные" параметры ему не нужны.
Я понимаю Вас как создателя скрипта по сборке справки, но сложности в написании такого скрипта не могут быть доминирующими над удобством чтения самой справки, которую будут читать тысячи пользователей и которым этот скрипт с его сложностью будет "до лампочки"Конец каждой строки не имеет постоянной позиции и неудобно выискивать эту метку
А вот звездочку можно оставить и в начале описания параметра, она не так будет мозолить глаза. Вы же сами предлагали [?], вот и замените ее на *опять же выискивать звёздочку.
Была такая мысль, но будет явное отклонение от оригинала справки, так как эти утилиты не входят в установщик по умолчанию.Возможно имеет смысл перенести темы с AutoIt3Wrapper, Obfuscator и Tidy в раздел Использование AutoIt
Сейчас всё возможно найти на вкладке "Указатель", введя даже часть слова. А на вкладке "Поиск" даже страницы где встречается слово., а то если не знать где они находяться, найти совершенно невозможно.
Вообще компилятор я получил от SyDr, я лишь его модернизировал, добавив Gui, некоторые подсветки по тексту.Я понимаю Вас как создателя скрипта по сборке справки
в контексте я имел ввиду неудобство чтения, а не сложность скрипта.но сложности в написании такого скрипта не могут быть доминирующими над удобством
Да, но звёздочка символ обязательного параметра. Кстати, вот и пример когда используется символьная метка без длинных текстов её описания.А вот звездочку можно оставить и в начало описания параметра, она не так будет мозолить глаза. Вы же сами предлагали [?], вот и замените ее на *
Откуда такая информация? Впервые слышу. :( Всегда считал звездочку в конце предложения символом примечания...звёздочка символ обязательного параметра.
"DllClose is still a good idea" буквально переводится "DllClose всё же хорошая идея". У нас так не говорят, у нас "рекомендуется". Буквальный перевод был при первом переводе справки, теперь есть желание осмыслить.Опционально - буквальный перевод слова optional
ок, я пришёл к программированию на AutoIt минуя msdn. Поэтому "опция" ассоциируется с некоторым переключателем, в котором может находится параметр, а не как не игнорирование параметра.так пишут на msdn - да везде это используется
я тоже могу чёнить написать, но не буду.Если ты хочешь сделать такую же, но с блек джеком и шлюхами - твоё право, но я бы предложил тогда на верхней крышке написать разноцветными весёлыми буквами Don`t panic и больше использовать ресунки, что бы и неумеющие читать всё поняли.
Ты меня непривильно понял - я говорю о том, что optional можно вообще не переводить, тк это элемент оформления, как содержание, поиск и тд слева, заголовок сверху и тд. Привычный элемент. Ты как автор русской справки можешь сделать как тебе угодно - мы как пользователи привыкнем к любому виду, но лучше придерживаться общепринятых стандартов.Опционально - буквальный перевод слова optional
Думаю правильнее будет «Использование DllClose всё же будет не плохой идеей» или «Использование DllClose всё же не помешает»."DllClose is still a good idea" буквально переводится "DllClose всё же хорошая идея"
да, ещё лучше.Использование DllClose всё же не помешает
1 Почему [Необязательный] с большой буквы? Это неграмотно.Предлагаю ещё раз проголосовать с учётом выше сказанного и с предпросмотром
Голосование здесь не уместно, пользоваться будут сотни, а голосовать всего несколько.Предлагаю ещё раз проголосовать
Я не хочу сделать хуже, или в пользу себе, поэтому я и хотел бы чтобы услышать продуманное мнение, а не потому что мы так привыкли и если поменяем вдруг будет хуже. Если будет 30% против символичной метки, думаю можно оставить ближе к оригиналу.Голосование здесь не уместно, пользоваться будут сотни, а голосовать всего несколько.
я уже добавил в примере выше всплывающую подсказку.если так сильно нравится вариант с [?], то стоит задуматься над реализацией акронима
для дискриминации , поправил.1 Почему [Необязательный] с большой буквы?
добавил2 Почему нет варианта с [необязательный] в конце описания?
Думаю если во всех одинаковый формат то лучше вынести это в описание к функции.3 Почему нет пункта в Примечании для варианта •?