草庐IT

Swift 文档 : instance/type property/method notation

coder 2023-09-09 原文

为了记录 Ruby，我会写，例如，Time::now 或 Time#day。我如何记录 Swift？

也就是说，在编写 Swift 文档时，类型及其 1) 类型属性或方法或 2) 实例属性或方法的表示法是什么？

例如，在 Ruby 文档中，符号 ::(两个冒号)表示类属性或方法，而符号 #(数字符号、散列、井号标签) , 或井号) 表示一个实例属性或方法。所以，Time::now 表示 now 是 Time 的类属性或方法，而 Time#day表示 day 是 Time 的实例属性或方法。

Swift 文档有这样的符号语法吗？

我知道 Swift 文档的函数符号——例如，Swift append(_ newElement: Element) method for Array被记录为 append(_:)——因为我在 Apple 的文档中看到了很多这种表示法的例子。但是，如何为 Swift 编写 Array#append(_:)？

最佳答案

不幸的是，Swift 没有官方或广泛接受的符号来区分类型属性/方法和具有类型名称前缀形式的实例属性/方法。

(因此，普通的 Swift 程序员(甚至专家)无法理解您的问题。)

类型名称前缀形式实际上是在Swift book中使用的, 但不是那么频繁。

据我检查:

  • 在某些部分，类型属性以类似 UInt32.max 的形式引用，但如您所见，这只是使用有效的实际符号作为 Swift 表达式。

  • 在其他一些地方，类型方法被称为类似 LevelTracker.unlock(_:) 的形式，但这在 Swift 中也是一个有效的表达式，我不确定Apple 将其用作类型方法的文档符号。我无法快速浏览 Swift 书中的示例，但初始化器通常以类似 String.init(data:encoding:) 的形式引用，这也是 Swift 中的有效表达式。

  • 对于其他情况，实例方法或属性被称为instanceVar.methodName(_:)或instanceVar.propertyName，当然是instanceVar 出现在附近的代码片段中并且不是类型名称，这实际上不是您要查找的内容。

如您所知，在 Apple 的官方引用资料中，方法或属性显示为标题 Instance method、Type method 、Instance Property或类型属性。或以 class/static var/let、class/static func、var/let 或 func 为前缀。

我找不到一个非常简短的调查的例子，但一些文章(包括 Apple 的)可能也以 TypeName.methodName(_:) (或实例属性)的形式引用实例方法以及。)Swift 社区似乎认为区分类型成员和实例成员并不重要。

我不能花太多时间，但似乎很明显

Swift 没有官方的或广泛接受的符号来区分类型属性/方法和带有类型名称前缀形式的实例属性/方法。

也许你需要写一些像实例方法 Array.append(_:) 来表示Array#append(_:)。

(注意，Array.append(_:) 在 Swift 中也是一个有效的表达式。)

关于Swift 文档 : instance/type property/method notation，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/45651377/

instancepropertycodeSwiftstrongclassdocumentationnotation

有关Swift 文档 : instance/type property/method notation的更多相关文章

  1. ruby-on-rails - 如何使用 instance_variable_set 正确设置实例变量？ - 2

    我正在查看instance_variable_set的文档并看到给出的示例代码是这样做的:obj.instance_variable_set(:@instnc_var,"valuefortheinstancevariable")然后允许您在类的任何实例方法中以@instnc_var的形式访问该变量。我想知道为什么在@instnc_var之前需要一个冒号:。冒号有什么作用？ 最佳答案 我的第一直觉是告诉你不要使用instance_variable_set除非你真的知道你用它做什么。它本质上是一种元编程工具或绕过实例变量可见性的黑客攻击

  2. Matlab imread（）读到了什么 （浅显 当复习文档了） - 2

    matlab打开matlab，用最简单的imread方法读取一个图像clcclearimg_h=imread('hua.jpg');返回一个数组（矩阵），往往是a*b*cunit8类型解释一下这个三维数组的意思，行数、数和层数，unit8：指数据类型，无符号八位整形，可理解为0~2^8的数三个层数分别代表RGB三个通道图像rgb最常用的是24-位实现方法，即RGB每个通道有256色阶（2^8）。基于这样的24-位RGB模型的色彩空间可以表现256×256×256≈1670万色当imshow传入了一个二维数组，它将以灰度方式绘制；可以把图像拆分为rgb三层，可以以灰度的方式观察它figure(1

  3. ruby - 为什么在类上调用 instance_eval() 时定义类方法？ - 2

    Foo=Class.newFoo.instance_evaldodefinstance_bar"instance_bar"endendputsFoo.instance_bar#=>"instance_bar"putsFoo.new.instance_bar#=>undefinedmethod‘instance_bar’我的理解是调用instance_eval在对象上应该允许您为该对象定义实例变量或方法。但是在上面的例子中，当你在类Foo上调用它来定义instance_bar方法时，instance_bar变成了一个可以用“Foo.instance_bar”调用的类方法。很明显这段代码没

  4. 带有 attr_accessor 的类上的 Ruby instance_eval - 2

    我了解instance_eval和class_eval之间的基本区别。我在玩弄时发现的是一些涉及attr_accessor的奇怪东西。这是一个例子:A=Class.newA.class_eval{attr_accessor:x}a=A.newa.x="x"a.x=>"x"#...expectedA.instance_eval{attr_accessor:y}A.y="y"=>NoMethodError:undefinedmethod`y='forA:Classa.y="y"=>"y"#WHATTT?这是怎么回事:instance_eval没有访问我们的A类(对象)然后它实际上将它添加到

  5. Ruby 等同于 Sphinx 文档生成器？ - 2

    Ruby有一些不错的文档生成器，例如Yard、rDoc，甚至Glyph。问题是Sphinx可以做网站、PDF、epub、LaTex等。它在重组文本中完成所有这些事情。在Ruby世界中有替​​代方案吗？也许是程序的组合？如果我也能使用Markdown就更好了。 最佳答案 自1.0版以来，Sphinx有了“域”的概念，它是从Python和/或C以外的语言标记代码实体(如方法调用、对象、函数等)的方法。有一个rubydomain,所以你可以只使用Sphinx本身。您唯一会缺少的(我认为)是Sphinx使用autodoc从源代码自动创建文档

  6. ruby - 模块中的 instance_eval 与 class_eval - 2

    classFooincludeModule.new{class_eval"deflab;puts'm'end"}deflabsuperputs'c'endendFoo.new.lab#=>mc======================================================================classFooincludeModule.new{instance_eval"deflab;puts'm'end"}deflabsuperputs'c'endend注意这里我把class_eval改成了instance_evalFoo.new.labresc

  7. ruby-on-rails - 在 irb 中阅读文档 - 2

    我怀念ipython的一件事是它有一个?为特定功能挖掘文档的运算符。我知道ruby​​有一个类似的命令行工具，但是我在irb中调用它非常不方便。ruby/irb有类似的东西吗？ 最佳答案 Pry是IPython的Ruby版本，它支持?命令来查找有关方法的文档，但语法略有不同:pry(main)>?File.dirnameFrom:file.cinRubyCore(CMethod):Numberoflines:6visibility:publicsignature:dirname()Returnsallcomponentsofthef

  8. ruby - 使用 Nokogiri 和 Ruby 从 html 文档获取链接和 href 文本？ - 2

    我正在尝试使用nokogirigem提取页面上的所有url及其链接文本，并将链接文本和url存储在散列中。FooBar我想回去{"Foo"=>"#foo","Bar"=>"#bar"} 最佳答案 这是一个单行:Hash[doc.xpath('//a[@href]').map{|link|[link.text.strip,link["href"]]}]#=>{"Foo"=>"#foo","Bar"=>"#bar"}拆分一点可以说更具可读性:h={}doc.xpath('//a[@href]').eachdo|link|h[link.t

  9. ruby - 如何让 Nokogiri 解析并返回 XML 文档？ - 2

    这是一些奇怪的例子:#!/usr/bin/rubyrequire'rubygems'require'open-uri'require'nokogiri'print"withoutread:",Nokogiri(open('http://weblog.rubyonrails.org/')).class,"\n"print"withread:",Nokogiri(open('http://weblog.rubyonrails.org/').read).class,"\n"运行此返回:withoutread:Nokogiri::XML::Documentwithread:Nokogiri::

  10. H2数据库配置及相关使用方式一站式介绍（极为详细并整理官方文档） - 2

    目录H2数据库入门以及实际开发时的使用1.H2数据库的初识1.1H2数据库介绍1.2为什么要使用嵌入式数据库？1.3嵌入式数据库对比1.3.1性能对比1.4技术选型思考2.H2数据库实战2.1H2数据库下载搭建以及部署2.1.1H2数据库的下载2.1.2数据库启动2.1.2.1windows系统可以在bin目录下执行h2.bat2.1.2.2同理可以通过cmd直接使用命令进行启动：2.1.2.3启动后控制台页面：2.1.3spring整合H2数据库2.1.3.1引入依赖文件2.1.4数据库通过file模式实际保存数据的位置2.2H2数据库操作2.2.1Mysql兼容模式2.2.2Mysql模式

随机推荐