Автокликер Clickermann :: Форум
Основной раздел => Предложения => Topic started by: Dr_midon on November 06, 2012, 11:25:15 AM
-
Начинающий программист не всегда знает стандартов, которые используются во множестве технической литературы. За сим предлагаю добавить в начальную(Введение:ФУНКЦИИ И ПРОЦЕДУРЫ) страницу описания программы следующее:
Параметры, которые принимают функции и процедуры, могут быть нескольких типов. Описание в справке может содержать следующий интуитивно понятный вид с любыми вариациями названия параметра:
$value - параметр является переменной(начинается с $, например: $var, $_return1, $_hwnd и т.п.);
"value" - параметр является строкой(параметр обрамлен кавычками, например: "filename", "parname" и т.п.)
value - параметр является числом(название без дополнительных смиволов, например: a, b, x, y, keycode)
[value] - необязательный параметр(параметр обрамлен квадратными скобками, например: ["section"], [mult], [$var] и т.п.)
А вообще, если комьюнити и автор не против, то могу взять на себя обязанность переписать(когда время свободное появится) справку по типу:
Функция StrLen
Синтаксис
StrLen(Str: String (http://String)): Integer (http://Integer);
Параметры
Str - входная строка
Описание
Возвращает количество символов в строке Str, причем нулевой символ окончания строки в длину не засчитывается
Пример
StrLen("lol") // результат "3"
См. также описание функций StrCut (http://StrCut), StrCut2 (http://StrCut2), StrFilter (http://StrFilter), StrPos (http://StrPos), StrConcat (http://StrConcat), StrReplace (http://StrReplace).
-
1. Начинающий программист не всегда знает...
2. Пример
StrLen("lol") // результат "3"
1. О том, что справка должна быть двухуровневая тут уже писали.
Лично я за то , чтобы вариант для новичков был максимально информативным
2. Не устану тут повторять, что примеры ( пусть даже самые короткие) должны иметь на 100% законченный вид "плюг энд плей" ---> (скопировал в справке , вставил в окно редактора. - получи результат).
Новичок не должен впадать с ступор, уже в самом начале освоения.
-
1. Лично я против того, "что справка должна быть двухуровневая". Достаточно одной справки, но которая подходила бы для всех. Не стоит людей делить, иначе нужно и двухуровневую программу делать и 2 виндовс и т.д. Да еще и людям придется рассказывать, какая справка написана для каждого из них(в какой тип относить конкретного пользователя). Кстати я почти весь форум уже прочитал :P и видел, о чем писали.
2. Согласен. Тут надо побольше подумать, как оформить примеры. Чтоб они и суть функции раскрывали, и "плюг энд плей" были, и не были растянутыми. Возможно нужно показать, как чаще всего используется данная функция.
-
1. Не стоит людей делить,
2. иначе нужно и двухуровневую программу делать и 2 виндовс и т.д.
3. еще и людям придется рассказывать, какая справка написана для каждого из них
4. Возможно нужно показать, как чаще всего используется данная функция.
1. Слабая аргументация.
Поясню:
а) люди по Природе своей делятся на физиков и лириков, причем у обеих категорий есть компьютеры , и есть желание облегчить себе рутину .
б) куцая , но всеобъемлющая справка не имеет логического смысла, ибо физику она не к чему вовсе ( и так все примерно знает) , а лирик её не поймет.
2. Продвинутый юзер таки и ушел из винды в линкус.
И правильно сделал. Рога о дуб винды ломать было не резон.
3. Масса уважаемых программ, обладающих дружественным интерфейсом, имеет 2 уровня сложности ( обычный и эксперт ).
Менее уважаемыми они от этого не становятся.
4. Хм... ну вот тут спорно, по той же причине - "физик-лирик".
Ну вот разные для них будут типовые примеры.
Блокнот, калькулятор, обычный поисковик гугла.
Думаю из этого набора и стоит создать "плюг энд плей" примеры для новичков.
А вот продвинутый юзер волне способен использовать прототипы продвинутых скриптов, которых тут в изобилии.
-
Во флуд превратилась тема, если дальше так пойдет, то можно во флуд перенести или удалить.
1. Слабая аргументация
2. Продвинутый юзер таки и ушел из винды в линкус
3. Масса уважаемых программ, имеет 2 уровня сложности
4. Как чаще всего используется данная функция
1. Я вообще дизайном на жизнь зарабатываю, но это ни сколько не мешает программить. Человек разумен. Если человеку интересна тема то он в ней разберется, а иначе даже не будет по справкам и форумам лазать. Необходимость тоже не исключаю, но если приперло, то обходиться придется простейшими функциями коих немало и запись действий тоже есть(но это уж совсем для одноразового использования). Можно несколько типовых примеров различных скриптов с избыточным числом комментариев запихать от простого к сложному.
2. Программа - это инструмент. Это не означает, что очень умный и талантливый плотник микроскопом гвозди забивает. Сервер поднимать надо на Linux`e - никто не спорит. А вот 3D пакетов моделирования там сколь(Blender - одна?)? А сколь из них поддерживают просчет глобального освещения? На сколько больше времени уходит на просчет одной картинки? Думаю, что есть еще не одна программа, которая не реализована на Linux в полной мере.
3. Согласен. 2 интерфейса уже есть. Что можно рассказать в справке для начинающих про первый? 4 кнопки: запись, проигрывание, стоп и закрыть? Для этого спец. справку нужно?
4. Блокнот, калькулятор, обычный поисковик гугла имеют места, куда нужно кликать. И они у всех есть и у физика, и у лирика. А процедуре LCLICK(123,456) без разницы, кто компом управляет и описание у нее, как и пример работы будет очень лаконичным. А для описания процедуры моей племяннице, например, SendMessage(WndFind("Receiver", 1), $WM_COPYDATA, 0, $cd) придется начинать с устройства Windows, описание так растянется, что уже будет не описанием этой конкретной процедуры, а будет статьей. Но статья - это не справка же?
-
Во флуд превратилась тема
Хмм... аргумент убойный.
Откланяюсь.
-
могу взять на себя обязанность переписать(когда время свободное появится) справку по типу:
Функция StrLen
Синтаксис
StrLen(Str: String (http://String)): Integer (http://Integer);
Параметры
Str - входная строка
Описание
Возвращает количество символов в строке Str, причем нулевой символ окончания строки в длину не засчитывается
Пример
StrLen("lol") // результат "3"
См. также описание функций StrCut (http://StrCut), StrCut2 (http://StrCut2), StrFilter (http://StrFilter), StrPos (http://StrPos), StrConcat (http://StrConcat), StrReplace (http://StrReplace).
Тоже пофлудить хочется)))) Думаю что комьюнити и автор не против)))) Только мне, как ламеру, в справке по "ТИПУ" ниччё не понятно, как и в той что уже есть в кликере)))) Если переписывать для неумелых пользователей, то писать надо языком понятным для НИХ(для меня например), а не как у вас по "ТИПУ"
Извините...