Skip to content

Link to source code from class/method/etc docs #25635

@pbiggar

Description

@pbiggar

(Can't find another issue on this, apologies if this is a dup)

Given that .NET is open source, the docs could link directly to the source code. This would be useful at a class level, but also for each method, constructor, property, and field.

Linking to the source code would help users easily answer questions that aren't yet documented. It would also be an entry point into contributing fixes for problems they discover. I personally have had many questions which could be solved by looking at the source, and in some cases I have, though finding the source for a method is a many-step process.

I'm imagining a little [src] link or github icon in the header of the method name. As an example of where this is done well, the Rust documentation site docs.rs has this for every function, struct, etc. For example

image

(See the [src] link in the top right, which goes to https://docs.rs/mode/0.4.1/src/mode/automaton.rs.html#238-242)

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