Documentation And Code Review Checklist for Apex Code and Unit Testing in Salesforce

Question

How to make documentation for Apex code written in salesforce application and for unit testing done in salesforce ?

Does Salesforce provide Code Review Checklist for Apex and Visualforce Code ? If Yes , then please tell me link ?and If not , how will i create it ?

I am a beginner level salesforce engg and currently working in software company and my project manager assigned me to write documentation for written classes and for testing classes too.

Is there any tool which can help me out in this problem ?

I am currently working in Eclipse , so is there any plugin for eclipse ?

Please reply me soon as possible .

Answer 1

As far as I know, the only tool out there today is ApexLang. I'm sure that others have also had an idea on how to do this, myself included, so I'd expect future projects out there to eventually provide true documentation support.

Answer 2

[SHAMELESS PLUG ALERT] ApexDox for VS Code provides an editor-integrated documentation experience for Apex code! You can contextually stub comment blocks, preview your docs in seconds, and much more :-) Check in out here: https://marketplace.visualstudio.com/items?itemName=PeterWeinberg.apexdox-vs-code&ssr=false

I created this project based on the original ApexDoc, however, its been completely rewritten in TypeScript (from Java), makes some (hoepful) improvements on some of the original's core logic, and takes great advantage of the VS Code ecosystem, where you're likely already writing all of your Apex code anyway. Suggestions and contributions are welcome!