Doc comments

Open
  • Is something wrong?
#178 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
csharp
Domain
developer-experience, documentation

Research direction

No file, test, or entry point is named. Start by inspecting the repository's C# project and build settings for documentation-comment generation, then check how the result is consumed by Visual Studio or Rider. Done means the existing code comments appear in those IDEs, or the repository documents why that is not possible.

Written by the indexing model from the issue text.

Description

I notice that the documentation in the code

image

isn't picked up by Visual Studio or Rider

image

which is a shame. Is there anything you need to do at your end to enable the doc-comments to be displayed?
e.g.

image

Dominant language
C#
Stars
87
Forks
32
No merged PRs in 30d

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from HDFGroup/HDF.PInvoke

All issues in HDFGroup/HDF.PInvoke

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.