草庐IT

Documentation

全部标签

python - 如何在 python 注释中指定输入和输出数据类型?

我见过几种标准,用于编写关于函数在Python中期望和返回的数据类型的注释。是否就哪一个是最佳实践达成共识?是http://www.python.org/dev/peps/pep-3107/中的新功能吗?我应该为此开始使用什么? 最佳答案 函数注解没有特定用途,它们可以用于任何事情。可以编写工具来从注释中提取信息并执行任何您想要的操作,包括检查类型或生成文档。但是python本身不会对这些信息做任何事情。您可以用于完全不同的目的,即提供将在参数上调用的函数或声明一串可能的返回值。注解可以是任何对象:defsomefunc(param

python - 如何记录鸭子类型(duck typing)?

我的文档太多了,因为每当我遇到一个复杂的鸭子类型(ducktyping)时,我都需要某种方式来表达“这个鸭子类型(ducktyping)”,但却陷入了“你的函数需要这个输入的这个”的无休止循环,但不记录它”,然后记录它。这会导致臃肿、重复的文档,例如:defFoo(arg):"""Args:arg:AnobjectthatsupportsXfunctionality,andYfunctionality,andcanbepassedtoZotherfunctionality."""#Insertcodehere.defBar(arg):"""Args:arg:Anobjectthatsu

python - 如何记录鸭子类型(duck typing)?

我的文档太多了,因为每当我遇到一个复杂的鸭子类型(ducktyping)时,我都需要某种方式来表达“这个鸭子类型(ducktyping)”,但却陷入了“你的函数需要这个输入的这个”的无休止循环,但不记录它”,然后记录它。这会导致臃肿、重复的文档,例如:defFoo(arg):"""Args:arg:AnobjectthatsupportsXfunctionality,andYfunctionality,andcanbepassedtoZotherfunctionality."""#Insertcodehere.defBar(arg):"""Args:arg:Anobjectthatsu

python - python 文档字符串中的@ivar @param 和@type 这些标签是什么?

ampoule项目在docstring中使用了一些标签,例如javadoc标签。例如来自pool.py第86行:defstart(self,ampChild=None):"""StartstheProcessPoolwithagivenchildprotocol.@paramampChild:aL{ampoule.child.AMPChild}subclass.@typeampChild:L{ampoule.child.AMPChild}subclass"""这些标签是什么,哪个工具使用它。 最佳答案 只是为了好玩,我会注意到Pyt

python - python 文档字符串中的@ivar @param 和@type 这些标签是什么?

ampoule项目在docstring中使用了一些标签,例如javadoc标签。例如来自pool.py第86行:defstart(self,ampChild=None):"""StartstheProcessPoolwithagivenchildprotocol.@paramampChild:aL{ampoule.child.AMPChild}subclass.@typeampChild:L{ampoule.child.AMPChild}subclass"""这些标签是什么,哪个工具使用它。 最佳答案 只是为了好玩,我会注意到Pyt

html - 如何链接到同一目录中的文档部分(pandoc markdown->html 输出)

我有两份相当简单的文档(用markdown编写,用于使用pandoc生成html文件)。我希望能够从第一个文档链接到第二个文档的一部分。解决方案的优先顺序:使用通用Markdown功能使用Pandoc扩展使用嵌入式HTML 最佳答案 Pandoc有一个“HeaderidentifiersinHTML”-这个用例的扩展。文档中有一个示例,说明如何提供从文档的一个部分到另一部分的链接。 关于html-如何链接到同一目录中的文档部分(pandocmarkdown->html输出),我们在Sta

html - 如何链接到同一目录中的文档部分(pandoc markdown->html 输出)

我有两份相当简单的文档(用markdown编写,用于使用pandoc生成html文件)。我希望能够从第一个文档链接到第二个文档的一部分。解决方案的优先顺序:使用通用Markdown功能使用Pandoc扩展使用嵌入式HTML 最佳答案 Pandoc有一个“HeaderidentifiersinHTML”-这个用例的扩展。文档中有一个示例,说明如何提供从文档的一个部分到另一部分的链接。 关于html-如何链接到同一目录中的文档部分(pandocmarkdown->html输出),我们在Sta

iphone - 在 mobilesafari webapp 中嵌入 html5 <audio>。是否可以在模态播放器中加载图像来代替 quicktime Logo ?

我一直无法找到解释这是否可能的资源。在此处找到的Apple文档https://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/Using_HTML5_Audio_Video/AudioandVideoTagBasics/AudioandVideoTagBasics.html#//apple_ref/doc/uid/TP40009523-CH2-SW1...没有提及此类功能。我还尝试使用嵌入音频拉出相同模态quicktime播放器的标签。有没有办法做到这一点,或者有没有办法在不打开模式外部播放

iphone - 在 mobilesafari webapp 中嵌入 html5 <audio>。是否可以在模态播放器中加载图像来代替 quicktime Logo ?

我一直无法找到解释这是否可能的资源。在此处找到的Apple文档https://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/Using_HTML5_Audio_Video/AudioandVideoTagBasics/AudioandVideoTagBasics.html#//apple_ref/doc/uid/TP40009523-CH2-SW1...没有提及此类功能。我还尝试使用嵌入音频拉出相同模态quicktime播放器的标签。有没有办法做到这一点,或者有没有办法在不打开模式外部播放

html - 如何将 Markdown 文档导出为不同的格式?

关闭。这个问题需要更多focused.它目前不接受答案。想改进这个问题吗?更新问题,使其只关注一个问题editingthispost.关闭4年前。Improvethisquestion编写文档作为一名开发人员,我一直在寻找编写和更新文档的最简单方法。不是尖叫“不要读我”的无聊文本,而是一些令人愉快(且轻松)格式化的内容,并且对代码的支持非常简单。从LaTeX到wiki再到Markdown,仅举几例,我认为Markdown已经很接近了。但是文档本身非常Nerd而且不是很便携。这将需要成为HTML和PDF。Markdown编辑器所以基本上我正在寻找一个编辑器、转换器或任何我没有想到的巧妙技