当前位置:首页 > 文章列表 > Golang > Go问答 > 如何在项目中注释共享的符号?

如何在项目中注释共享的符号?

来源:stackoverflow 2024-03-02 16:42:24 0浏览 收藏

有志者,事竟成!如果你在学习Golang,那么本文《如何在项目中注释共享的符号?》,就很适合你!文章讲解的知识点主要包括,若是你对本文感兴趣,或者是想搞懂其中某个知识点,就请你继续往下看吧~

问题内容

假设我有一个 go 项目,它充当另一个 go 项目中的共享库。如何标记在该项目之外使用的 go 符号(常量、结构、变量)?

我想根本的问题是我很难知道哪些代码使用了所述符号。

请注意:这与语义版本控制无关,我非常清楚并使用它。我知道 semver 可以帮助识别重大变更。

相反,这是为了查明我是否真的破坏了我自己的项目之一(相比之下:该符号应该不导出或在包外使用)。我正在考虑 go 中不存在的某种注释。

顺便说一句,intellij 也不知道,并将这些符号标记为“不必要导出”。也许以 intellij 为中心的解决方案就足够了。

为了说明我的问题:

package sharedlib

import "time"

// myfavoritetimeformat is a blablabla...
const myfavoritetimeformat = time.rfc3339
package dependingproject

import "github.com/thething/sharedlib"
import "time"

func convertToString(timestamp time.Time) string {
    return timestamp.Format(sharedlib.MyFavoriteTimeFormat)
}

当我愉快地重命名 myfavoritetimeformate 并发布它时,代码将在更新依赖项时在依赖项目中中断。


解决方案


在其他软件包需要之前不要导出任何内容。如果另一个包需要什么东西,那么就进行export,然后你就会知道,如果有东西被导出,那是因为它是在包之外使用的。并且不要对导出的标识符进行重大更改。如果确实必须,请增加主要版本。使用go模块,不会破坏现有的其他包,它们将继续使用旧版本。

如果您的模块被分解为多个包(因为它“大”),并且您希望仅为模块的其他包导出某些内容,则使用内部包概念,因此它仍然是“未导出” “(不可导入)到其他模块。详情见Can I develop a go package in multiple source directories?

以上就是《如何在项目中注释共享的符号?》的详细内容,更多关于的资料请关注golang学习网公众号!

版本声明
本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
在Golang中高效地修改Map数据结构在Golang中高效地修改Map数据结构
上一篇
在Golang中高效地修改Map数据结构
递归遍历文件系统的方法
下一篇
递归遍历文件系统的方法
查看更多
最新文章
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    542次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    510次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    498次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    484次学习
查看更多
AI推荐
  • AI边界平台:智能对话、写作、画图,一站式解决方案
    边界AI平台
    探索AI边界平台,领先的智能AI对话、写作与画图生成工具。高效便捷,满足多样化需求。立即体验!
    397次使用
  • 讯飞AI大学堂免费AI认证证书:大模型工程师认证,提升您的职场竞争力
    免费AI认证证书
    科大讯飞AI大学堂推出免费大模型工程师认证,助力您掌握AI技能,提升职场竞争力。体系化学习,实战项目,权威认证,助您成为企业级大模型应用人才。
    405次使用
  • 茅茅虫AIGC检测:精准识别AI生成内容,保障学术诚信
    茅茅虫AIGC检测
    茅茅虫AIGC检测,湖南茅茅虫科技有限公司倾力打造,运用NLP技术精准识别AI生成文本,提供论文、专著等学术文本的AIGC检测服务。支持多种格式,生成可视化报告,保障您的学术诚信和内容质量。
    543次使用
  • 赛林匹克平台:科技赛事聚合,赋能AI、算力、量子计算创新
    赛林匹克平台(Challympics)
    探索赛林匹克平台Challympics,一个聚焦人工智能、算力算法、量子计算等前沿技术的赛事聚合平台。连接产学研用,助力科技创新与产业升级。
    642次使用
  • SEO  笔格AIPPT:AI智能PPT制作,免费生成,高效演示
    笔格AIPPT
    SEO 笔格AIPPT是135编辑器推出的AI智能PPT制作平台,依托DeepSeek大模型,实现智能大纲生成、一键PPT生成、AI文字优化、图像生成等功能。免费试用,提升PPT制作效率,适用于商务演示、教育培训等多种场景。
    549次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码