Skip to content

add xml comment to with methods#56

Closed
lucavoit wants to merge 2 commits intoMelGrubb:mainfrom
lucavoit:add-xml-comment
Closed

add xml comment to with methods#56
lucavoit wants to merge 2 commits intoMelGrubb:mainfrom
lucavoit:add-xml-comment

Conversation

@lucavoit
Copy link

@lucavoit lucavoit commented Feb 3, 2025

proposed change to implement suggested feature in #48

@MelGrubb
Copy link
Owner

MelGrubb commented Feb 5, 2025

I think the idea looks solid. I wonder how the behavior will change between windows and *nix-based systems with different line endings, though. Logically, the way to test it might be to prepare a file with windows-style endings (/r/n) and check the results. Then, do a search and replace on the same input to turn them into plain "\n"s and make sure the results are identical. Since the code you have is just looking for "\n", it should catch both styles just fine, but varification would be good.

There are currently conflicts with main. A lot happened over the last weekend, so that's not surprising. I'm hoping to call v3.0 finished very soon. Hopefully this week.

@MelGrubb
Copy link
Owner

MelGrubb commented Feb 5, 2025

I hand-grafted the new code into the current main branch, and it works, although the lines after the first weren't indented. Trying to do this dynamically might be more trouble than it's worth. Since you already have the FormatCommentWithTripleSlash method, the easiest place to add the indenting is there. I'll push that change up soon.

I guess I need to figure out where to document contributors now. I think v3.1.0-beta is just about ready. I realize my naming was off on the alphas, so I guess I've burned a third digit. I'll live, though.

@MelGrubb
Copy link
Owner

MelGrubb commented Feb 5, 2025

I'm closing this PR since it's been implemented in PR #57. Thank you for the code. If you pull main now, you can see the final version. It's not far off, but it includes XML comment headers on the properties as well as the With methods, and fixes some minor formatting issues.

@lucavoit
Copy link
Author

lucavoit commented Feb 5, 2025

Great to hear that my suggestion was of use to you :)
I'm looking forward to working with v3 once it's released

@lucavoit lucavoit closed this Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants