Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

.NET Core project does not include all the important file#146

Unanswered
ravichandrasingh asked this question inQ&A
Discussion options

How can I generate documentation for all the files in a .NET Core project?

I've noticed that often the documentation doesn't include all methods and properties of the classes (.cs files).
Also, when the generation process breaks partway through, it restarts from the beginning next time instead of resuming from where it left off. This causes it to use more tokens and makes it more costly.

How can I include the all-important class (.cs file) to generate the document?

Some case if class has more than 10 methods, code generate only the one or two method's document and leaving the rest out and including a note in the documentation like"// ... many more remaining methods and properties ..."
image

Please help me with the issue described above so that I can generate documentation for my entire .NET Core project effectively.

You must be logged in to vote

Replies: 1 comment 5 replies

Comment options

How can I include the all-important class (.cs file) to generate the document?

Update the--include to include all files you want

pythonmain.py--dir/path/to/your/codebase--include"*.cs"

Some case if class has more than 10 methods, code generate only the one or two method's document and leaving the rest out and including a note in the documentation like "// ... many more remaining methods and properties ..."

Yeah this is expected. It try to skip redundant methods.

- Each code block should be BELOW 10 lines! If longer code blocks are needed, break them down into smaller pieces and walk through them one-by-one. Aggresively simplify the code to make it minimal. Use comments{code_comment_note} to skip non-important implementation details. Each code block should have a beginner friendly explanation right after it{instruction_lang_note}.

You can update the instruction.

You must be logged in to vote
5 replies
@ravichandrasingh
Comment options

@zachary62 Thanks for your response.

I’ve already made the necessary changes, but not all .cs files are being included in the generated documentation.
image

@zachary62
Comment options

@zachary62 Thanks for your response.

I’ve already made the necessary changes, but not all .cs files are being included in the generated documentation.image

Maybe it's because of the EXCLUDE? Could you also try to tune these?

@ravichandrasingh
Comment options

Hi@zachary62 ,

I’ve already fine-tuned the exclude patterns to filter out irrelevant files and folders such as bin, obj, .git, .gitignore, .vs, test, and other non-essential directories.
For your information, the codebase contains around 80–90 important abstractions, but the documentation generator only captures about 15–20 of them, leaving the majority unprocessed.

@zachary62
Comment options

You can tune the # abstractions using:

# Add max_abstraction_num parameter to control the number of abstractions
parser.add_argument("--max-abstractions",type=int,default=10,help="Maximum number of abstractions to identify (default: 10)")

@ravichandrasingh
Comment options

already done!
image

And also update in the class "IdentifyAbstractions"
image

and pass the max-abstractions as below at run time.

python main.py --dir {projcet location} --max-size 10000 --max-abstractions 200 --output ./output/Test

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Category
Q&A
Labels
None yet
2 participants
@ravichandrasingh@zachary62
[8]ページ先頭
©2009-2025 Movatter.jp