• Products
  • Solutions
  • Made with Unity
  • Learning
  • Support & Services
  • Community
  • Asset Store
  • Get Unity

UNITY ACCOUNT

You need a Unity Account to shop in the Online and Asset Stores, participate in the Unity Community and manage your license portfolio. Login Create account
  • Blog
  • Forums
  • Answers
  • Evangelists
  • User Groups
  • Beta Program
  • Advisory Panel

Navigation

  • Home
  • Products
  • Solutions
  • Made with Unity
  • Learning
  • Support & Services
  • Community
    • Blog
    • Forums
    • Answers
    • Evangelists
    • User Groups
    • Beta Program
    • Advisory Panel

Unity account

You need a Unity Account to shop in the Online and Asset Stores, participate in the Unity Community and manage your license portfolio. Login Create account

Language

  • Chinese
  • Spanish
  • Japanese
  • Korean
  • Portuguese
  • Ask a question
  • Spaces
    • Default
    • Help Room
    • META
    • Moderators
    • Topics
    • Questions
    • Users
    • Badges
  • Home /
avatar image
1
Question by ashjack · Apr 02, 2014 at 06:54 PM · functionmonodevelopclasscustomdocumentation

Custom Documentation for Monodevelop

Hi. I am writing a rather large class with functions, and I have a list of values that tell me which is which. However, whenever I want to check it, I have to manually open up the function in which I have written it. I know there is a way in Eclipse, but is there a way in Monodevelop to write your own custom documentation?

Comment
Add comment
10 |3000 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users

1 Reply

· Add your reply
  • Sort: 
avatar image
2
Best Answer

Answer by LEDWORKS · Apr 02, 2014 at 07:20 PM

Intellisense my good friend! :)

Comment your code with /// or does MonoDevelop not have this functionality? I use VisualStudio and previously Unitron.

Comment
Add comment · Show 6 · Share
10 |3000 characters needed characters left characters exceeded
▼
  • Viewable by all users
  • Viewable by moderators
  • Viewable by moderators and the original poster
  • Advanced visibility
Viewable by all users
avatar image fafase · Apr 02, 2014 at 07:22 PM 0
Share

$$anonymous$$onoDevelop indeed has this feature.

avatar image ashjack · Apr 02, 2014 at 07:28 PM 0
Share

I do use //

But in Eclipse, there is a way to make these show up in a popup while you are typing an instance of that function. Currently in $$anonymous$$onodevelop, the only information that appears in the popup is the names of the variables that I need to input.

avatar image ashjack · Apr 02, 2014 at 07:31 PM 0
Share

I believe it's called Javadoc, or something like that.

avatar image fafase · Apr 02, 2014 at 07:31 PM 2
Share

You need three / two is only commenting, three of them will create a default documentation that is often laughable as it tries to use the name of the method and convert it to a sentence.

Once you have it then you type the method and the info shows up.

This is what I get:

  /// <summary>
 /// $$anonymous$$ies the method.
 /// </summary>
 /// <returns>The method.</returns>
 /// <param name="first">First.</param>
 /// <param name="second">Second.</param>
 float $$anonymous$$y$$anonymous$$ethod(float first, string second){} 
avatar image ashjack · Apr 02, 2014 at 08:47 PM 0
Share

Ah, thanks! I thought LEDWOR$$anonymous$$S has just made a typo. I'll try the /// method tomorrow.

Show more comments

Your answer

Hint: You can notify a user about this post by typing @username

Up to 2 attachments (including images) can be used with a maximum of 524.3 kB each and 1.0 MB total.

Welcome to Unity Answers

If you’re new to Unity Answers, please check our User Guide to help you navigate through our website and refer to our FAQ for more information.

Before posting, make sure to check out our Knowledge Base for commonly asked Unity questions.

Check our Moderator Guidelines if you’re a new moderator and want to work together in an effort to improve Unity Answers and support our users.

Follow this Question

Answers Answers and Comments

22 People are following this question.

avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image avatar image

Related Questions

Magic Spell Types - SpellType.Fire/Water/Earth? 1 Answer

Return a custom class from function 1 Answer

Custom inheritance classes and custom inspectors 2 Answers

"Null Reference Error" when using a custom class as an array 1 Answer

MonoDevelop not showing description of methods etc. with autocomplete? 1 Answer


Enterprise
Social Q&A

Social
Subscribe on YouTube social-youtube Follow on LinkedIn social-linkedin Follow on Twitter social-twitter Follow on Facebook social-facebook Follow on Instagram social-instagram

Footer

  • Purchase
    • Products
    • Subscription
    • Asset Store
    • Unity Gear
    • Resellers
  • Education
    • Students
    • Educators
    • Certification
    • Learn
    • Center of Excellence
  • Download
    • Unity
    • Beta Program
  • Unity Labs
    • Labs
    • Publications
  • Resources
    • Learn platform
    • Community
    • Documentation
    • Unity QA
    • FAQ
    • Services Status
    • Connect
  • About Unity
    • About Us
    • Blog
    • Events
    • Careers
    • Contact
    • Press
    • Partners
    • Affiliates
    • Security
Copyright © 2020 Unity Technologies
  • Legal
  • Privacy Policy
  • Cookies
  • Do Not Sell My Personal Information
  • Cookies Settings
"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
  • Anonymous
  • Sign in
  • Create
  • Ask a question
  • Spaces
  • Default
  • Help Room
  • META
  • Moderators
  • Explore
  • Topics
  • Questions
  • Users
  • Badges