Topic on User talk:Aelanna

Jump to navigation Jump to search
Yuki303 (talkcontribs)

Hallo

I was thinking about documenting rimworld's C# API and Harakoni pointed me to you.

I don't know if i should throw everything on here or leave this wiki's modding section for tutorials and host the technical API documentation externally or something. I knew there was quite of stuff to document but it was even more than I thought hhh,,, But should I be putting the docs on this wiki?

Also a few things if the pages are gonna stay:

  • im currently putting both getter-only properties and readonly fields as a readonly modifier, simply since as far as i'm aware they functionally serve the same purpose when being used from the outside (i may be wrong on this). Should i have readonly as readonly and getter's not have readonly but a note in their descriptions about it?
  • I initially was going for a unity-esque documentation with description properties constructors methods, but after how long Pawn was i decided to switch to a more functional categorization; but categorizing them is kind of iffy since a lot of them bleed into other categories (eg. EquippedWornOrInventoryThings in combat or equipment) any suggestions
    • unity esque docs would be nice for modders planning to create subclasses;
  • a simpler question, since most enums i've encountered so far while sifting through rimworlds code are short should I just throw them all in one page

Sorry for the long message hhh thanks

Reply to "C# Documentation"