标签: documentation

有人有 Quirks 模式（特别是 IE Quirks 模式）中存在 bug 的 HTML、JavaScript 和 CSS 的完整列表吗？

我已经在http://www.quirksmode.org/css/quirksmode.html查看了 quirksmode.org 列表，但它似乎并不全面。例如，我发现某些浏览器存在框架问题，除非您使用框架集文档类型。

谢谢，咩

I am using Ruby on Rails 3.1.0 and I am trying to use YARD 0.7.4. I would like to document constant values, so in my class I state this:

# [Fixnum] Test constant documentation.
TEST_CONSTANT = 1

but the HTML output after I run the yardoc (or yard doc) command is the following:

In the above image is shown that the HTML documentation is not good rendered/generated, at least not as I would expect. I read the YAML documentation …

我找不到任何查找所有svn错误代码的地方？ - 我只是手动谷歌'svn E200005'.某处不应该有详尽的清单吗？

我有一个包含 Java 8 LocalDate 类型字段的 DTO。使用 Jackson 注释可以将格式设置为ISO.DATE并且一切正常。但是 Swagger（我有版本 2.+）看到LocalDate.classas 对象

LocalDate {
month (integer, optional),
year (integer, optional)
}

（这是真的，但是...）我想将其表示为带有格式的字符串，因为它适用于util.Date. 我该如何解决？

我的客户给了我不寻常（且不可协​​商）的要求，要求他们从 C++ 代码中提供双语言（英语和波兰语）doxygen 文档。

我的第一个想法是对评论使用条件编译，例如：

#if DOXYGEN_ENGLISH
/**
 * @brief Sample method
 */
#elif DOXYGEN_POLISH
/**
 * @brief Przyk?adowa metoda
 */
#endif
void foo();

然后使用不同的基本语言环境和预定义的常量运行 Doxygen 两次......它确实有效。但是太麻烦了...

有人知道如何改进此解决方案吗？还是用不同的方式解决？

我有带有 spring-restdocs 的 spring-boot 应用程序，我想在该应用程序中为生成的文档创建端点。使用生成的 html 文档（由 asciidoctor）公开端点的最佳方法是什么？

我可以将 index.html 包含到 jar 文件中，但不知道如何创建将使用该 html 并暴露在外部的端点。此 html 在测试阶段之后和构建 jar 阶段之前生成。

来自官方文档：您可以将您创建的 HTML 文档发布到静态网站，或者将其打包并从应用程序本身提供。

例如，我在“build/asctiidoctor/html5”文件夹中有 index.html 并且想要创建将返回该 index.html 的控制器。

我正在浏览Ruby Core API，并在“ 类”列表的底部注意到“未知” 。当您访问该课程的页面，网址为https://ruby-doc.org/core-2.6.1/unknown.html时，您会发现其中没有内容。

该课程的目的是什么，即您何时以及如何使用它？如果没有目的，为什么将其记录在ruby-doc.org上？

我看到可以在 pycharm 中添加外部文档，您需要设置外部文档的 url，但我找不到 scikit-learn 的 url。

我想知道是否有人知道 Scikit-learn 的 url 模式？

我试图collect通过阅读一些文档来了解函数的全部功能。我遇到了一些挑战，特别是在页面上引用的最后一个例子中（也在下面列出，我的评论内嵌）

let results = [Ok(1), Err("nope"), Ok(3), Err("bad")];

let result: Result<Vec<_>, &str> = results.iter().cloned().collect();

// gives us the first error <-- Point 1
assert_eq!(Err("nope"), result);

let results = [Ok(1), Ok(3)];

let result: Result<Vec<_>, &str> = results.iter().cloned().collect();

// gives us the list of answers
assert_eq!(Ok(vec![1, 3]), result);

我用我自己的一些代码跟进了这段代码（如下所示）

let results: [std::result::Result<i32, &str>; 2] = [Err("nope"), Err("bad")];

let result: Vec<Result<i32, &str>> = results.iter().cloned().collect();

// The following prints <-- Point 2
// "nope"
// "bad"
for x in result{ …

过去，Macintosh OS 的一个怪癖是文件有两个“分叉”，一个“资源分叉”通过专用资源 API 保存软件使用的资源，另一个“数据分叉”保存普通的旧文件其他系统上的数据，包括二进制代码、纯文本文件中的文本等。

1998 年随 Mac OS 8.1 引入的HFS+ 的一个鲜为人知的功能是，您可以拥有任何文件的任意数量的命名分支。类似于 NTFS 的另一个鲜为人知的功能，称为“ADS”（备用数据流）。

来自维基百科：

HFS Plus 允许最多 255 个字符的文件名，以及类似于 NTFS 的n-forked 文件，尽管直到 2005 年，除了数据叉和资源叉之外几乎没有系统软件利用叉

Apple 似乎不再记录使用这些额外分叉的 API。

我们是否知道 Apple 是否以及何时正式弃用该功能？如果没有，我们是否知道 API 何时从文档中消失。