首页
学习
活动
专区
圈层
工具
发布

Objective-C 枚举值注释

枚举值特别多的时候,想每一个枚举值都具体注释提示的话,就只能在每个枚举上一行加上/// ···或/** ··· */,但是会让代码显得不整齐(可能是我强迫症?)...,如果需要给每个枚举值增加一个简短的注释,并且在使用的时候有注释提示可以这样写。 - 带提示代码后单行注释 ://!注释: /**< ··· */和 /*!...< 类型C */ }; 枚举注释 这种注释方法,同样适合类的属性注释或者结构体属性注释。...下面是OC中常见的一些注释: - 基本单行注释: // 一般在方法内对一些步骤进行注释,有时写在代码上一行,有时也接着代码写: // 测试方法 - (NSArray *)testFunctionWithString...#pragma mark - 注释#> mark1 同时在新的 Xcode 的 MiniMap 中也能直接看到注释 mark2 - 未做提示注释 //TODO: ··· Swift一致 一般用来标识需要做的工作

1.7K20

yml字符串值写法,单双引号区别,换行用法

字符串默认不需要引号 如果字符串包含空格或者特殊字符(例如冒号),需要加引号 双引号不会对串中转义字符进行转义 #实际值为 something \n something str: "something...\n something" 单引号会对串中转移字符进行转义 #实际值为 something 换行 something str: 'something \n something' 字符串写成多行,第二行开始需要带单空格缩进...,换行符被替换为空格 #实际值为 line1 line2 line3 str: line1 line2 line3 多行字符串可以用 | 保留换行 #实际值为 line1换行line2换行line3...换行 str: | line1 line2 line3 |+ 保留块尾换行 #实际值为 line1换行line2换行line3换行换行换行 str: |+ line1 line2 line3...other: ... |- 删除串尾换行 #实际值为 line1换行line2换行line3 str: |- line1 line2 line3 other: ...

10.1K20
  • 您找到你想要的搜索结果了吗?
    是的
    没有找到

    python函数基础-参数-返回值-注释-01

    ,默认使用定义阶段就已经绑定的值 # 在调用的时候如果可以给默认值形参传值 传了那么就使用你传的值 # 在定义阶段 默认值形参必须放在位置形参的后面 ''' 默认值参数的应用场景(例如录入信息时的性别)...z 和 m 都不是默认值参数和位置参数, 他们是命名关键字参数 函数的注释 函数注释的好处: # 规范的代码注释可以让封装的方法被快速读懂,让调用者快速上手.......(有着诸多好处) # 在pycharm 中只需要在函数定义def 关键字下一行 敲 ''' 回车即可自动出现函数注释格式,只需相应填充即可 """ 该函数的作用 :param x: 对形参x的解释 :...param y: 对形参y的解释 :return: 对函数返回值的解释 """ 查看写好的函数注释: # help(函数名) ,会返回该函数的注释信息 def say_hi(name): '''...参数、注释, 下面给出一个标准的函数定义格式 """ def 函数名(形参1, ......): ''' 该函数的作用(函数的注释) :param 形参1: 对形参1的解释

    2.1K10

    C# 如何给 ValueTuple 返回值添加注释

    在 C# 7.0 可以在一个方法的返回,返回多个参数,通过 ValueTuple 的方法,但是和单个参数返回不同的是,如何对多个参数返回每个参数进行单独的注释?...如使用下面的代码,我尝试在一个方法返回两个不同的概念的值,在之前,如果通过 out 的返回,我可以单独给每个参数做注释 static (int s, int t) F(int x, int y) {...return (x + y, x - y); } 我找了很多博客,发现可以使用的方法是在返回值注释里面使用 para 分割多个参数 /// /// /// 注释 s 参数.../// /// /// 注释 t 参数 /// /// static (int s, int t) F(int x, int y)...name attributes in doc comments for a tuple return value · Issue #145 · dotnet/csharplang 还在想如何给多个参数返回值添加文档注释

    80910

    K8S包管理神器-Helm

    可以看出.Release.Name渲染成了release名,如果想要查看所有的变量/常量 #{{ . }} 模板注释 模板中的注释有2种 yaml的注释 模板的注释 yaml注释 # This is...true Release.IsInstall:如果当前操作是安装的话,需要将该值设置为true Release.Revision:此次修订的版本号。...内置很多模版函数,这里无法一一列举,因此选取几个常用来说明 quote:双引号 {{ quote .Release.Name }} default:默认值 # 当找不到.Values.hello时默认为...将hostname的值改为服务器IP,例如192.168.36.128,如果改成域名,要能解析 2....例如表示deployment副本数,不要有的用replicas,有的用replicaCount 建议2:给参数加注释。因为chart写好后很少需要改动,时间长了容易忘。

    5.8K32

    高效的Shell编程建议及入坑

    /usr/bin/env bash 2)注释 注释的意义不仅在于解释用途,而在于告诉我们注意事项,就像是一个README。...注释一般包括下面几个部分: 脚本的写作时间,作者,版权等 脚本的函数参数 脚本的函数用途 脚本函数的注意事项 一些较复杂的单行命令注释 3)缩进有规矩,太长要分行 正确的缩进是很重要的,尤其是在写函数的时候...--name "*.txt" | xargs -P $(nproc) sed -i "s/223/666/g;s/235/279/g" 2)勤用双引号 推荐在使用”$”来获取变量的时候最好加上双引号,当使用一个变量的值时...,用双引号有助于防止由于空格导致单词分割开和由于识别和扩展了通配符而导致的不必要匹配; 不加上双引号在很多情况下都会造成很大的麻烦,为什么呢?...main "$@" #调用主函数并传入命令行的参数 5)函数返回值 在使用函数返回值要注意shell中函数的返回值只能是整数,估计是因为一般情况下一个函数的返回值通常表示这个函数的运行状态,所以一般都是

    1.2K10

    helm charts 模板编程

    如果需要双引号",则需要添加\来进行转义,而squote函数的用途则是用双引号将字符串括起来,而不会对内容进行转义。 辅助模板 有时你想在图表中创建一些可重复使用的部分,无论它们是块还是模板部分。...以下示例将返回mynamespace对象的注释: (lookup "v1" "Namespace" "" "mynamespace").metadata.annotations 返回对象列表时lookup...,这是因为当前的作用域就在当前循环内,这个.从列表的第一个元素一直遍历到最后一个元素,然后在遍历过程中使用了title和quote这两个函数,前面这个函数是将字符串首字母变成大写,后面就是加上双引号变成字符串...的说明: 子 chart 是独立的,所以子 chart 不能明确依赖于其父 chart 子 chart 无法访问其父 chart 的值 父 chart 可以覆盖子 chart 的值 Helm 中有全局值的概念...我们可以看到两个模板中都输出了allin: helm这样的值,全局变量对于传递这样的信息非常有用,不过也要注意我们不能滥用全局值。

    7.6K40

    外包精通--在 ArgoCD 中加载现有的 Helm 应用程序

    您希望在默认 helm 值上覆盖的任何 helm 自定义值都需要添加到helm 值部分。...这里的主要思想是通过 ArgoCD 指定的 helm 值配置应该与helm 安装或升级时指定的配置(值文件)完全匹配。...例如,在 helm 安装期间,如果服务类型是ClusterIP,ArgoCD 应用程序清单也应该具有该配置。如果您不指定,ArgoCD 将覆盖默认图表值,这将导致停机。...您可以在此处的文档中阅读有关此注释的更多信息。 让我们的sync应用程序将在所有资源上应用该 ArgoCD 注释。 同步后,您可以看到没有资源被删除或重新创建。...checksum/secret 迁移到 ArgoCD 时,需要应用其自己的注释,如上所示。 一旦该注解应用于秘密,其校验和就会发生变化,并且该校验和将在部署中得到更新。

    4K41

    【每日一个云原生小技巧 #22】Helm Values.yaml 的作用和编写方式

    Values.yaml 是 Helm 图表的一个关键组件,它在 Helm 图表中用于定义可配置的参数,从而实现对 Kubernetes 应用部署的自定义配置。...编写方式 Values.yaml 文件通常包含一系列键值对,这些键值对定义了图表中使用的变量和它们的默认值。...图表的复用:通过参数化,使得同一个 Helm 图表可以被用于部署不同的实例或服务。 使用技巧 分层的值文件:为不同环境或部署场景创建多个 values 文件,并在部署时指定适当的文件。...使用默认值:在 values.yaml 中为每个参数提供合理的默认值,以简化基本部署。 模板化表达式:在图表的其他文件中使用模板表达式引用 values.yaml 中的值。...值的覆盖:在部署命令中使用 --set 参数来覆盖 values.yaml 中的默认值。 结构化和注释:组织好 values 文件的结构,并充分注释,以提高可读性和可维护性。

    1.6K100

    告别手写,一键生成 Helm Chart README 文件

    前言 随着云原生应用的普及,Helm 的作用也日益凸显,越来越多的云原生应用以 Helm Chart 的形式发布,可以说现在如果没有一个 Helm Chart 都不好意思说自己是云原生应用。...但这也给云原生应用的开发者提出了挑战,开发者不但需要把 value.yaml 和 Chart.yaml 等文件的参数以 Markdown 的形式搬运到 README.md 文件中,同时还要将参数的默认值,...Helm-docs helm-docs 可以根据 charts 内容自动生成 markdown 文件。..." jnorwood/helm-docs:latest # 或者 docker run -v "$(pwd):/helm-docs" jnorwood/helm-docs:latest --dry-run...添加参数说明 helm-docs 可以通过 value.yaml 中的注释生成参数说明,注释格式如下所示,-- 后的内容会自动填充到 Chart Values 的 Description 中: # access_key_id

    1K41

    一键生成 Helm Chart README 文档

    前言 随着云原生应用的普及,Helm 的作用也日益凸显,越来越多的云原生应用以 Helm Chart 的形式发布,可以说现在如果没有一个 Helm Chart 都不好意思说自己是云原生应用。...但这也给云原生应用的开发者提出了挑战,开发者不但需要把 value.yaml 和 Chart.yaml 等文件的参数以 Markdown 的形式搬运到 README.md 文件中,同时还要将参数的默认值,...Helm-docs helm-docs 可以根据 charts 内容自动生成 markdown 文件。..." jnorwood/helm-docs:latest # 或者 docker run -v "$(pwd):/helm-docs" jnorwood/helm-docs:latest --dry-run...添加参数说明 helm-docs 可以通过 value.yaml 中的注释生成参数说明,注释格式如下所示,-- 后的内容会自动填充到 Chart Values 的 Description 中: # access_key_id

    1.6K10

    GitLab Runner部署(kubernetes环境)

    部署GitLab Runner之前,先把chart的仓库添加到helm的仓库列表中: helm repo add gitlab https://charts.gitlab.io 下载GitLab Runner...参数位置,添加gitlabUrl的配置,其值就是前面在GitLab网页取得的gitlab url参数,如下图红框: 第二处,找到已被注释掉的runnerRegistrationToken参数位置,...的值都改成true(创建RBAC、创建容器gitlab-bastion用于管理job的容器): 设置此GitLab Runner的tag为k8s,在pipeline脚本中可以通过指定tag为k8s...,这样pipeline就会在这个Gitlab Runner上允许: 找到cache的配置,在修改之前,cache的配置如下图,可见值为空内容的大括号,其余信息全部被注释了: 修改后的cache...配置如下图,红框1中原先的大括号已去掉,红框2中的是去掉了注释符号,内容不变,红框3中填写的是minio的访问地址,红框4中的是去掉了注释符号,内容不变: 上图红框4中的s3CacheInsecure

    1K40
    领券