• Visitors can check out the Forum FAQ by clicking this link. You have to register before you can post: click the REGISTER link above to proceed. To start viewing messages, select the forum that you want to visit from the selection below. View our Forum Privacy Policy.
  • Want to receive the latest contracting news and advice straight to your inbox? Sign up to the ContractorUK newsletter here. Every sign up will also be entered into a draw to WIN £100 Amazon vouchers!
Collapse

You are not logged in or you do not have permission to access this page. This could be due to one of several reasons:

  • You are not logged in. If you are already registered, fill in the form below to log in, or follow the "Sign Up" link to register a new account.
  • You may not have sufficient privileges to access this page. Are you trying to edit someone else's post, access administrative features or some other privileged system?
  • If you are trying to post, the administrator may have disabled your account, or it may be awaiting activation.

Previously on "Documenting c# Classes"

Collapse

  • eek
    replied
    Originally posted by ASB View Post
    I've found this useful for processing the embedded XML doc and interfacing to sandcastle.

    Sandcastle Help File Builder - Download: SHFB v1.9.3.0 Release
    Sandcastle but I happily used GhostDoc for ages (considering everyone else used nothing it made me look organised).

    Leave a comment:


  • ASB
    replied
    Originally posted by billybiro View Post
    The best thing for this is Sandcastle.

    I've used it in the past for almost the same same reasons as yourself. Be warned, though, that it's not the most "polished" utility, and will require that you've decorated your classes/functions with /// style xml comments and will also require you to craft some xslt files to style the output. Oh, and it's all command line-driven.
    I've found this useful for processing the embedded XML doc and interfacing to sandcastle.

    Sandcastle Help File Builder - Download: SHFB v1.9.3.0 Release

    Leave a comment:


  • billybiro
    replied
    Originally posted by Spacecadet View Post
    Anyone got any tips - preferably outputting to word
    Need something like

    Abstract Class
    -property
    -property
    -method
    -method etc..
    class - inherits abstract class
    -property
    -property
    -method
    -method etc..

    etc etc etc
    The best thing for this is Sandcastle.

    I've used it in the past for almost the same same reasons as yourself. Be warned, though, that it's not the most "polished" utility, and will require that you've decorated your classes/functions with /// style xml comments and will also require you to craft some xslt files to style the output. Oh, and it's all command line-driven.

    Leave a comment:


  • jmo21
    replied
    good summary of options here though the question in the link is a bit stupid itself.

    Leave a comment:


  • Spacecadet
    started a topic Documenting c# Classes

    Documenting c# Classes

    Anyone got any tips - preferably outputting to word
    Need something like

    Abstract Class
    -property
    -property
    -method
    -method etc..
    class - inherits abstract class
    -property
    -property
    -method
    -method etc..

    etc etc etc
Working...
X