Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
There is so many option in each programming languages which can be mentioned in the code documentation.
I want to know what are the most important Items which we have to document?
I'd document contracts (this parameter is expected not to be null, this function never returns null, ...) as well as the meaning (this method does that, ...). Besides documenting the API, I'd add comments on pieces of code which are non-trivial but add a significant value to the application (cryptic but real fast, works around a framework bug).
What you document ultimately depends a lor on who will read that documentation...
Related
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 2 years ago.
Improve this question
I've always struggled with how to format SQL queries in terms of whitespace, alignment, etc. It seems whenever there is an "auto-formatter" it seems to format things differently than the next one, whether it is within a SQL client or a website or text-editor that does various language formatting. Are there any guideline(s) for how SQL should be formatted for best readability? Here is an example of how I currently do it:
SELECT
name
FROM
sales_instance si
JOIN main_iteminstance i ON si.instance_id=i.id
ORDER BY
name
Also, yes I know this may be 'opinion-based' and people may want to close it for that, but I think this answer is helpful as to writing clean SQL and hopefully someone can provide a good summary of the available formats or guidelines.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 4 years ago.
Improve this question
Is it possible to create API documents on JIRA? If yes then how? The currently employed approach involves creating / updating a Microsoft Word document and replacing it on Confluence. This approach though fulfills the requirement but do not seems a better way for API documentation management.
Thanks
Uploading Microsoft Word documents is probably the worst way.
Although I find Confluence (and JIRA) to be terrible, I write API docs using a table and it works well:
Once you have a template, copy and paste to grow the docs.
Closed. This question needs to be more focused. It is not currently accepting answers.
Want to improve this question? Update the question so it focuses on one problem only by editing this post.
Closed 8 years ago.
Improve this question
I have realized that most of the problems that I solve on a day to day basis are done via two programming techniques: iteration or recursion.
Are there other techniques out there? Any book recommendations or online references?
the programming techniques that you use to solve the problems can be divided into types of algorithms (not into the loop or technique they use in there program, like you mentioned). some of the methods are..
1. Divide and conquer
2. greedy
3. dynamic programming
you can refer this link to read more..
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 8 years ago.
Improve this question
I have phased out a few classes from a project and removed all references to them. Is it better practice to make them obsolete or delete them from the project?
I am a sole developer of this system. I have spent some time Googling this and I have also looked at a few articles on MSDN. However, I cannot find the answer to my specific question.
If nobody else is using your system it is redundant to keep this classes/methods.
Deprecating classes/methods is usefull if you got some clients of your code and you do not want to make their code crash. You are deprecating classes/methods then to indicate that new users should use something else.
Closed. This question is opinion-based. It is not currently accepting answers.
Want to improve this question? Update the question so it can be answered with facts and citations by editing this post.
Closed 5 years ago.
Improve this question
i am working on some modules,actually change them.
but i don't know how i should document changes in a way that be clear and usefull for future changes.
would someone help me on this issue?
thanks.
If your project is written in one of the languages Doxygen supports, I strongly recommend using that to document your code.
By using Doxygen comments in your source code, you can easily generate documentation in a number of formats by running one command.