pl
а что не костыль
Size: a a a
2021 May 24
VG
перловый POD не костыль
gо
Докстринги лучше POD
gо
POD лишь немного лучше отдельного файла с документацией
gо
У тебя всё равно документация функции находится не рядом с функцией, что неудобно
VG
ровно наоборот
gо
Go:
Rust:
Python:
// Doc comment
func foo() { }
Rust:
/// Doc comment
fn foo() { }
Python:
def foo():
"""Docstring"""
VG
чего? именно рядом с ней и находится
VG
вот, я же говорил, говно
gо
Ноп. Весь POD, который я видел, был внизу файла, а не рядом с функцией
VG
ты похоже слишком мало видел
gо
Т. е. можно легко:
1. Удалить функцию и забыть удалить документацию
2. Добавить функцию и забыть добавить документацию
3. Изменить функцию и забыть изменить документацию
1. Удалить функцию и забыть удалить документацию
2. Добавить функцию и забыть добавить документацию
3. Изменить функцию и забыть изменить документацию
gо
https://github.com/libwww-perl/libwww-perl/blob/master/lib/LWP/UserAgent.pm
Берём какую-нибудь библиотеку, которую все используют. Документация выглядит так.
Берём какую-нибудь библиотеку, которую все используют. Документация выглядит так.
gо
В самом низу, после
__END__ идёт уже =podgо
Соответственно, каждое название функции дублировано руками два раза — в самом коде и в POD. Зачем? Потому что POD так устроен.
VG
ну да, вот беру какую-нибудь библиотеку, которую все используют, и вижу POD между функциями
gо
Чем это лучше, чем, скажем, растовые доккомменты?
VG
затем, что в POD можно дать название более подходящее для доки, чем в самой субе, что и видно на скрине
gо
Всё равно есть «настоящее» название, через которое ты функицю вызываешь
gо
То, что в Perl аргументов естественным образом нет в сигнатуре функции это родовая болезнь Perl.