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.
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 3 years ago.
Improve this question
In the karate project I am trying I have used karate's ability to assert database entries. And I was looking for a way to insert SQL scripts as a 'given' inside the test rather than calling a java class. Did not see any example in the demo project of karate.
What would be the ideal way to do this?
If you have already seen the JDBC demo and still feel that is too complicated, then I'm sorry - look for another framework :)
Also see this example if it helps: https://twitter.com/KarateDSL/status/1144458169822806016
And the whole Given When Then approach is over-rated, see: https://stackoverflow.com/a/47799207/143475
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 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
How much time is required to learn bootstrap?
just use the official website www.getbootstrap.com
Go through the Getting Started section, it will cover all the main things to know about using this amazing framework.
After that, just try to build a simple website using the responsive grids and available components.
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
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...