Microsoft headers 对声明没有评论那么文档在哪里?
Microsoft headers have no comments on declarations so where is the documentation?
通常(据我所知),在 Visual Stdio 中,我经常 right-click 使用开源库的函数 "go to definition" 或 "go to declaration"。这引导我找到 header 文件,我通常可以在其中找到很多关于特定功能的文档。如果我尝试使用 Microsoft-headers 中的函数进行此操作,我只会得到一些奇怪的代码,但没有关于该函数的文档。
例如,如果我选择 "go to declaration" 和 printf
,我会得到:
_Check_return_opt_
_CRT_STDIO_INLINE int __CRTDECL printf(
_In_z_ _Printf_format_string_ char const* const _Format,
...)
我在这里错过了什么吗?是否存在另一种方式?你在哪里看这些东西?
微软代码不是self-documenting这种方式。它们不打算被凡人阅读。这只是开发人员做出的选择。不同的项目采用不同的文档编制方法。有些人随意发表评论,有些人写 out-of-band 文档(例如 on Microsoft Docs),还有一些人根本不提供任何评论!
对于 Windows 的东西,我通常会 Google 例如printf visual studio
.
通常(据我所知),在 Visual Stdio 中,我经常 right-click 使用开源库的函数 "go to definition" 或 "go to declaration"。这引导我找到 header 文件,我通常可以在其中找到很多关于特定功能的文档。如果我尝试使用 Microsoft-headers 中的函数进行此操作,我只会得到一些奇怪的代码,但没有关于该函数的文档。
例如,如果我选择 "go to declaration" 和 printf
,我会得到:
_Check_return_opt_
_CRT_STDIO_INLINE int __CRTDECL printf(
_In_z_ _Printf_format_string_ char const* const _Format,
...)
我在这里错过了什么吗?是否存在另一种方式?你在哪里看这些东西?
微软代码不是self-documenting这种方式。它们不打算被凡人阅读。这只是开发人员做出的选择。不同的项目采用不同的文档编制方法。有些人随意发表评论,有些人写 out-of-band 文档(例如 on Microsoft Docs),还有一些人根本不提供任何评论!
对于 Windows 的东西,我通常会 Google 例如printf visual studio
.