Иными словами, есть ли смысл сохранить общий для всех функций

Question

Иными словами, есть ли смысл сохранить общий для всех функций

префикс и сохранить флаги на уровне библиотеки?
Или лучше убрать префикс (т.к. функции всё равно в таблице-неймспейсе) и заменить передачу интовых флагов в функции на таблицы с параметрами?

TL;DR:
lib.lib_func1(param1, param2, lib.FLAG1 | lib.FLAG3)
vs
lib.func1(param1, param2, {flag1 = true, some_value = something })

За первый вариант говорит то, что не нужно делать документацию или много пояснений, и все примеры переносятся почти 1 в 1. Против него, кажется, говорит всё остальное.

#lua #programming #russian

0

08.01.2021

5 ответов

9 просмотров

Aleksej Автор вопроса

Snusmumriken
2 Документацию всё равно нужно делать. Примеры и ...

> Документацию всё равно нужно делать. Не уверен, что в этом есть смысл, если можно сослаться на официальную документацию, указав разницу в API. Написать полноценную документацию для ~100 функций там, где официальная документация не очень хорошо структурирована (т.е. её нельзя сконвертировать) — работа в несколько раз больше, чем сгенерировать биндинг. По крайней мере, если не уверен, что этим кто-то кроме тебя когда-нибудь будет пользоваться.

0

09.01.2021

Snusmumriken

Aleksej
> Документацию всё равно нужно делать. Не уверен, ...

В подобном виде, всё равно крайне желательна документация, за примером биндинга почти без доки можно посмотреть сюда: https://luapower.com/libcurl или сюда: https://luapower.com/clipper. В этом очень неудобно разбираться, постоянно скача между одной докой и другой, ещё приходится смотреть на код биндинга, чтобы понимать какие константы где что означают, где какая версия либы была использована и т.д. Плюс придётся документировать твои разрешения ситуаций несовместимости типов, а ля "сишная функция хочет список указателей строк с указанием количества элементов".

0

09.01.2021

Aleksej Автор вопроса

Aleksej
> Документацию всё равно нужно делать. Не уверен, ...

Биндил-биндил, и наконец прибиндил. https://github.com/Penguinum/luavox Движок трекера SunVox. Можно играть и генерировать музыку (например, в играх на love2d).

0

12.01.2021

LISP ONE LOVE

Aleksej
Биндил-биндил, и наконец прибиндил. https://github...

Блять, ты просто чудо.

0

12.01.2021

Snusmumriken · Accepted Answer

Snusmumriken

2 Документацию всё равно нужно делать. Примеры и так переносятся 1в1, если у тебя есть строка с require твоей библиотеки: local mylib = require"mylib" print( mylib.foo(10, 20) )

0

08.01.2021

169 похожих чатов

Иными словами, есть ли смысл сохранить общий для всех функций

5 ответов

Похожие вопросы