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.
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
Can anyone help me
We'd like to create our startup MVP dynamic website with transaction, scheduling(calendar) and matching system using Python(django) and mongodb, can we use a shared hosting for that? (if yes, can you guys recommend?) reason is that no one in our team knows linux yet if we use vps.
beginner here and we don't have tech lead yet in our team 😣 we're trying to do it on our own (funding reasons).
We believe in our idea but we're short in resources. I hope you guys can help us. Thank you in advance!
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
Please suggest me a good option between an IDE/Online compiler. As a beginner, I would like to have knowledge regarding an organized method for coding also most comfortable between the above
Maybe you should check this answer: https://stackoverflow.com/a/4331490/12703498
It doesn't apply only to .net IMO. It really depends what and how you want to learn programming languages.
As a beginner, I would like to have knowledge regarding an organized method for coding also most comfortable between the above
Tech lead and experience will teach you this better than anything 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 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 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.
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...