PureBasic - форум

Информация о пользователе

Привет, Гость! Войдите или зарегистрируйтесь.

Вы здесь » PureBasic - форум » Вопросы по PureBasic » Инструмент для описания процедуры в комментариях

Инструмент для описания процедуры в комментариях

Страница: 1

Сообщений 1 страница 8 из 8

1

  • Автор: Webarion
  • Активный участник
  • Откуда: Москва
  • Зарегистрирован: 19.12.2021
  • Приглашений: 0
  • Сообщений: 96
  • Уважение: [+1/-0]
  • Позитив: [+12/-1]
  • Пол: Мужской
  • Возраст: 41 [1981-08-05]
  • Провел на форуме:
    3 дня 15 часов
  • Последний визит:
    Сегодня 11:30:44

Друзья, может кто-нибудь знает, существует ли инструмент PB, для автоматического создания описания к процедуре и её параметров, подобно как в AutoIt?
Что-то типа такого:

Код:
; #FUNCTION# ====================================================================================================================
; Name...........: _ArrayAdd
; Description ...: Adds a specified value at the end of an existing array.
; Syntax.........: _ArrayAdd(ByRef $avArray, $vValue)
; Parameters ....: $avArray - Array to modify
;                  $vValue  - Value to add
; Return values .: Success - Index of last added item
;                  Failure - -1, sets @error
;                  |1 - $avArray is not an array
;                  |2 - $avArray is not a 1 dimensional array
; Author ........: Jos van der Zande <jdeb at autoitscript dot com>
; Modified.......: Ultima - code cleanup
; Remarks .......:
; Related .......: _ArrayConcatenate, _ArrayDelete, _ArrayInsert, _ArrayPop, _ArrayPush
; Link ..........:
; Example .......: Yes
; ===============================================================================================================================
Func _ArrayAdd(ByRef $avArray, $vValue)
...

Отредактировано Webarion (21.06.2022 11:37:55)

0

2

  • Автор: AZJIO
  • Активный участник
  • Зарегистрирован: 07.08.2020
  • Приглашений: 0
  • Сообщений: 590
  • Уважение: [+9/-0]
  • Позитив: [+10/-0]
  • Провел на форуме:
    11 дней 17 часов
  • Последний визит:
    Сегодня 11:02:58

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

0

3

  • Автор: Webarion
  • Активный участник
  • Откуда: Москва
  • Зарегистрирован: 19.12.2021
  • Приглашений: 0
  • Сообщений: 96
  • Уважение: [+1/-0]
  • Позитив: [+12/-1]
  • Пол: Мужской
  • Возраст: 41 [1981-08-05]
  • Провел на форуме:
    3 дня 15 часов
  • Последний визит:
    Сегодня 11:30:44
AZJIO написал(а):

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

Так я и делаю. Просто интересно, вдруг есть.

0

4

  • Автор: Webarion
  • Активный участник
  • Откуда: Москва
  • Зарегистрирован: 19.12.2021
  • Приглашений: 0
  • Сообщений: 96
  • Уважение: [+1/-0]
  • Позитив: [+12/-1]
  • Пол: Мужской
  • Возраст: 41 [1981-08-05]
  • Провел на форуме:
    3 дня 15 часов
  • Последний визит:
    Сегодня 11:30:44

Заморочился я всё-таки и сделал этот инструмент: Commentator - Инструмент PB IDE для быстрой вставки описания процедуры
Пока на тестировании.

0

5

  • Автор: Lin
  • Активный участник
  • Зарегистрирован: 18.11.2020
  • Приглашений: 2
  • Сообщений: 87
  • Уважение: [+5/-0]
  • Позитив: [+4/-0]
  • Провел на форуме:
    5 дней 3 часа
  • Последний визит:
    27.03.2023 16:21:47

Есть два "похожих" инструмента:
https://bullshit-softworx.itch.io/docmaker
https://www.purebasic.fr/english/viewtopic.php?t=73066
жаль у всех "форматы" свои, а было бы интересно, если бы все "дружили"...

Отредактировано Lin (18.08.2022 01:57:04)

0

6

  • Автор: Webarion
  • Активный участник
  • Откуда: Москва
  • Зарегистрирован: 19.12.2021
  • Приглашений: 0
  • Сообщений: 96
  • Уважение: [+1/-0]
  • Позитив: [+12/-1]
  • Пол: Мужской
  • Возраст: 41 [1981-08-05]
  • Провел на форуме:
    3 дня 15 часов
  • Последний визит:
    Сегодня 11:30:44
Lin написал(а):

Есть два "похожих" инструмента:

Я видел, искал ведь. Тестировал не понравилось. Не люблю теги в комментах. Не хочу никого обидеть, но си-шарповские комменты с тегами считаю отстоем. Комментарий описывающий процедуру, должен быть более менее простой, текст должен пониматься интуитивно быстро. Но на C# в VisualStudio структура комментов мне не нравится. Понятно, что это заточено под VS, которая компонует всплывающие подсказки на основе таких XML-образных комментов. Но, для восприятия программистом, это затрата драгоценнейших наносекуд мышления.

Lin написал(а):

жаль у всех "форматы" свои, а было бы интересно, если бы все "дружили"...

Один формат, скорее всего утопия. Но вот, чтобы "дружили" ... Возможно когда-то появится некий транстятор, как переводчик между языками. Одного шаблона всё равно ведь не будет.
Лично я, выбрал способ комментирования из AutoIt, мне нравится. К тому же, старался сделать настройки гибкими, в файле настроек, который появляется после первого запуска инстумента, можно настроить внешний вид под себя, и отображаемые пункты (пункты можно как добавлять так и удалять). Скрин:
https://forumupload.ru/uploads/0009/ae/28/644/t658547.jpg

Можно потестить и например добавить в секцию [Elements] что-то вроде такого:

Скрытый элемент:  Show = 0 | Параметр в скрытом элементе = Ну вы блин даёте
Ещё один элемент: Show = 1 | Default = {Elements/Скрытый элемент/Параметр в скрытом элементе}
И ещё пример:       Show = 1 | Default = Какой-то текст...

В результате, в комментариях описываемых процедуру, будет появляться следующее:

; Ещё один элемент .: Ну вы блин даёте
; И ещё пример .....: Какой-то текст...

Отредактировано Webarion (18.08.2022 23:34:20)

0

7

  • Автор: Пётр
  • Активный участник
  • Зарегистрирован: 14.06.2009
  • Приглашений: 0
  • Сообщений: 2809
  • Уважение: [+94/-5]
  • Позитив: [+1/-0]
  • Пол: Мужской
  • Провел на форуме:
    2 месяца 6 дней
  • Последний визит:
    28.03.2023 16:30:44

Как по мне слишком много текста в комментарии.
Так проще.

Код:
; Процедура складывает числа.
; Результат - сумма параметров.
Procedure Plus(x, ; Первое складываемое число.
               y) ; Второе складываемое число.
  ProcedureReturn x+y
EndProcedure

0

8

  • Автор: Webarion
  • Активный участник
  • Откуда: Москва
  • Зарегистрирован: 19.12.2021
  • Приглашений: 0
  • Сообщений: 96
  • Уважение: [+1/-0]
  • Позитив: [+12/-1]
  • Пол: Мужской
  • Возраст: 41 [1981-08-05]
  • Провел на форуме:
    3 дня 15 часов
  • Последний визит:
    Сегодня 11:30:44
Пётр написал(а):

Так проще.

Само собой так проще всего)))
Я всё же больше за систематизированное описание процедур, на основе которого, возможно например автоматизировать всплывающую подсказку, или даже собрать основную часть HELP'a. И пока-что способ записи принятый в AutoIt, мне нравится больше всего, для таких задач.

Отредактировано Webarion (19.08.2022 00:00:03)

0

Страница: 1

Вы здесь » PureBasic - форум » Вопросы по PureBasic » Инструмент для описания процедуры в комментариях