Skip to content

Add link to source file from header comment #223

@PeterJohnson

Description

@PeterJohnson

For team discoverability of GitHub source code, it might be helpful to automatically add a link in the header to the file on GitHub, similar to what RTD does. E.g.

// Copyright block
//
// This file can be found on GitHub at the following location:
// https://github.com/wpilibsuite/allwpilib/blob/main/wpilibj/src/main/java/edu/wpi/first/wpilibj/ADXL362.java

One problem with this is the link is almost certainly longer than the allowed line length, which may cause other formatters/style checkers (PMD, Checkstyle) to complain?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions