Maison  >  Article  >  développement back-end  >  Meilleur moyen de créer un lien vers un autre package dans le fichier doc.go

Meilleur moyen de créer un lien vers un autre package dans le fichier doc.go

PHPz
PHPzavant
2024-02-09 22:20:081128parcourir

链接到 doc.go 文件中另一个包的最佳方法

l'éditeur php Baicao vous présentera la meilleure façon de créer un lien vers un autre package dans le fichier doc.go. Lorsque nous utilisons plusieurs packages dans un projet en langage Go, nous devons parfois référencer la documentation d'autres packages dans le fichier doc.go. Dans ce cas, nous pouvons utiliser la commande « go doc » pour afficher la documentation, mais quelle est la meilleure façon si nous voulons créer un lien direct vers la documentation d'autres packages dans le fichier doc.go ? Dans l’article suivant, nous expliquerons en détail comment atteindre cet objectif.

Le contenu des questions

ne fonctionne pas dans les fichiers doc.go 文件中编写包文档时,链接到另一个包中的文档的最佳方法是什么?不幸的是,引用导入包的常规方法在 doc.go car les importations inutilisées ne sont pas autorisées.

// package foo docs in a doc.go file
// foo uses [bar.bar] types for doing things.
package foo

import "foo.com/jonathan/godoctest/bar" // unused import error here

Utiliser un chemin pleinement qualifié fonctionne, mais vous n'obtiendrez pas la documentation la plus lisible :

// Package foo docs in a doc.go file
// foo uses [foo.com/jonathan/godoctest/bar.Bar] types for doing things.
package foo

Y a-t-il une solution ?

Solution

Utilisez une variable nommée _ pour référencer l'identifiant dans le package importé (identifiant vierge)

// Package foo docs in a doc.go file
// foo uses [bar.Bar] types for doing things.
package foo

import "foo.com/jonathan/godoctest/bar"

var _ bar.SomeType // where bar.SomeType is a type
var _ = bar.Value // where bar.Value is a func, var, constant, ...

Une seule référence au package importé est requise. Le code ci-dessus montre les différentes manières de référencer un type ou une valeur.

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration:
Cet article est reproduit dans:. en cas de violation, veuillez contacter admin@php.cn Supprimer