У заголовков Microsoft нет комментариев к объявлениям, так где же документация? - PullRequest
2 голосов
/ 10 июля 2019

Как правило (насколько я знаю), в Visual Stdio я часто щелкаю правой кнопкой мыши функцию «перейти к определению» или «перейти к объявлению» с библиотеками с открытым исходным кодом.Это приводит меня к заголовочным файлам, где я обычно нахожу много документации о конкретных функциях.Если я попробую это с функциями из заголовков Microsoft, я получу какой-то странный код, но не документирую эту функцию.

Например, если я выберу «перейти к декларации» с помощью printf, я получу это:

_Check_return_opt_
    _CRT_STDIO_INLINE int __CRTDECL printf(
        _In_z_ _Printf_format_string_ char const* const _Format,
        ...)

Я что-то здесь пропускаю?Существует ли другой путь?Где тебе искать эти вещи?

1 Ответ

3 голосов
/ 10 июля 2019

Код Microsoft не самодокументируется таким образом.Они не предназначены для чтения простыми смертными.Это просто выбор, который был сделан разработчиками.Различные проекты используют разные подходы к документации.Некоторые обильно распространяют комментарии, другие пишут внеполосную документацию (например, в Microsoft Docs ), а некоторые вообще не удосуживаются ее предоставить!

Для Windows-приложений я обычно будуGoogle например printf visual studio.

...