unusedfunc

Documentation

Overview

Package unusedfunc defines an analyzer that checks for unused functions and methods

Analyzer unusedfunc

unusedfunc: check for unused functions and methods

The unusedfunc analyzer reports functions and methods that are never referenced outside of their own declaration.

A function is considered unused if it is unexported and not referenced (except within its own declaration).

A method is considered unused if it is unexported, not referenced (except within its own declaration), and its name does not match that of any method of an interface type declared within the same package.

The tool may report false positives in some situations, for example:

• For a declaration of an unexported function that is referenced from another package using the go:linkname mechanism, if the declaration's doc comment does not also have a go:linkname comment.

  (Such code is in any case strongly discouraged: linkname annotations, if they must be used at all, should be used on both the declaration and the alias.)

• For compiler intrinsics in the "runtime" package that, though never referenced, are known to the compiler and are called indirectly by compiled object code.

• For functions called only from assembly.

• For functions called only from files whose build tags are not selected in the current build configuration.

See https://github.com/golang/go/issues/71686 for discussion of these limitations.

The unusedfunc algorithm is not as precise as the golang.org/x/tools/cmd/deadcode tool, but it has the advantage that it runs within the modular analysis framework, enabling near real-time feedback within gopls.

Index

• Variables

Variables

var Analyzer = &analysis.Analyzer{
	Name:     "unusedfunc",
	Doc:      analysisinternal.MustExtractDoc(doc, "unusedfunc"),
	Requires: []*analysis.Analyzer{inspect.Analyzer},
	Run:      run,
	URL:      "https://pkg.go.dev/golang.org/x/tools/gopls/internal/analysis/unusedfunc",
}