প্রশ্ন ট্যাগ «documentation»

অনেক লোকের দাবি, "মন্তব্যে 'কেন' ব্যাখ্যা করা উচিত, তবে 'কীভাবে' তা নয়"। আবার কেউ কেউ বলে যে "কোডটি স্ব-ডকুমেন্টিং হওয়া উচিত" এবং মন্তব্যগুলি খুব কমই হওয়া উচিত। রবার্ট সি মার্টিন দাবি করেছেন যে (আমার নিজের কথায় পুনরায় জবাব দেওয়া) প্রায়শই "মন্তব্যগুলি খারাপভাবে লিখিত কোডের জন্য ক্ষমা প্রার্থনা করে"। আমার প্রশ্নটি …

236 programming-practices  documentation  comments 

আমাকে বিশেষভাবে লাইন দ্বারা লাইন দেওয়ার জন্য বলা হয়েছে (বা যথাযথ - উদাহরণস্বরূপ, চিত্র দ্বারা চিত্র ইত্যাদি) ব্যাখ্যা বা ভাষ্য যা আমার বস পড়তে এবং অনুসরণ করতে সক্ষম হতে চান। যেহেতু তিনি প্রোগ্রামার নন, তিনি কোডটি অনুসরণ করতে পারেন না তাই এটি সমস্তই ইংরেজিতে অনুবাদ করা চায়। এর আগে কি …

155 documentation 

আরএফসি 2606 স্ট্যান্ডার্ডটি ডকুমেন্টেশনে উদাহরণ হিসাবে ব্যবহারের উদ্দেশ্যে , ডোমেন নামগুলি উদাহরণ.org , example.net এবং example.com সংরক্ষণ করে । একটি ফোন নম্বর (দেশীয় কোড সহ) এর সমতুল্য কী যা উদাহরণ হিসাবে ব্যবহার করা যেতে পারে, যেমন ব্যবহারকারীদের ইনপুট ফোন নম্বরগুলিকে কোন বিন্যাসে একটি উদাহরণ দেওয়ার জন্য? সর্বোত্তম ক্ষেত্রে, এটি আদর্শ …

112 documentation  standards  help-documentation 

মনে করুন আমি তুলনামূলকভাবে বড় একটি প্রকল্প বিকাশ করছি। আমি ইতিমধ্যে আমার সমস্ত ক্লাস এবং ডোজিজেনের সাথে ফাংশন নথিভুক্ত করেছি, তবে, প্রতিটি সোর্স কোড ফাইলে একটি "প্রোগ্রামার নোট" রাখার আমার ধারণা ছিল। এর পিছনে ধারণাটি কোনও নির্দিষ্ট শ্রেণি কীভাবে কাজ করে (এবং কেবল বেশিরভাগ মন্তব্য কেন তা করে না) সাধারণ …

104 documentation  large-scale-project 

সর্বশেষতম সংস্করণ থেকে তৃতীয় পক্ষের এসডিকে রোলব্যাক সংক্রান্ত একটি বৈঠকের সময় এটি উল্লেখ করা হয়েছিল যে আমাদের বিকাশকারীরা প্রতিশ্রুতিবদ্ধ ইতিহাসে ইতিমধ্যে পতাকাঙ্কিত করেছে যে সর্বশেষতম সংস্করণটি ব্যবহার করা উচিত নয়। কিছু বিকাশকারী যুক্তি দিয়েছিলেন যে এটি একটি খারাপ অনুশীলন ছিল এবং এটি পরিবর্তে উত্স ফাইলে (যেমন // Don't upgrade SDK …

94 version-control  documentation 

আমি মোটামুটি বড় প্রকল্পে কাজ করছি এবং এর জন্য কিছু অনুবাদ করার কাজ পেয়েছি। এমন অনেকগুলি লেবেল ছিল যা অনুবাদ করা হয়নি এবং আমি কোডটি খনন করার সময় এই ছোট্ট কোডটির টুকরোটি পেয়েছি //TODO translations এটি আমাকে নিজের (এবং অন্যদের?) এই মন্তব্যগুলির বোধ সম্পর্কে ভাবতে বাধ্য করেছে কারণ আমি অনুভূতি …

86 documentation  comments 

আমি নিম্নলিখিত কোডটি লিখেছি: if (boutique == null) { boutique = new Boutique(); boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.persist(boutique); } else { boutique.setSite(site); boutique.setUrlLogo(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getLogo()); boutique.setUrlBoutique(CmsProperties.URL_FLUX_BOUTIQUE+fluxBoutique.getUrl()); boutique.setNom(fluxBoutique.getNom()); //boutique.setSelected(false); boutique.setIdWebSC(fluxBoutique.getId()); boutique.setDateModification(new Date()); boutiqueDao.merge(boutique); } এখানে একটি মন্তব্য-আউট লাইন আছে। কিন্তু আমি কোড পরিষ্কার করে তোলে, সুস্পষ্ট উপার্জন কি পার্থক্য …

83 documentation  comments 

প্রথমত, এই প্রশ্নে আমি উত্স কোড মন্তব্য করা ভাল বা খারাপ কিনা তা নিয়ে পোলমিক থেকে দূরে থাকতে চাই। আমি কেন আরও স্পষ্টভাবে বোঝার চেষ্টা করছি যখন লোকেরা যখন এমন মন্তব্য সম্পর্কে কথা বলেন যা আপনাকে কেন, কী বা কীভাবে বলে। আমরা প্রায়শই "মতামত আপনাকে কেন বলা উচিত; কোড নিজেই …

78 documentation  comments 

আমি তিন মাস আগে একটি প্রকল্পে কাজ করছি, এবং তারপরে হঠাৎ করেই অন্য একটি জরুরি প্রকল্প হাজির হয়েছিল এবং আমাকে আমার দৃষ্টি আকর্ষণ করতে বলা হয়েছিল। আগামীকাল থেকে, আমি পুরানো প্রকল্পের দিকে ফিরে যাব। আমি বুঝতে পারি যে আমি ঠিক কী করছিলাম তা মনে নেই। আমি জানি না কোথা থেকে …

72 project-management  documentation 

আমি আমার বর্তমান চাকরিটি ছেড়ে দেওয়ার পরিকল্পনা করছি কারণ আমরা মাঝারি ভাগ করে নেওয়া হোস্টিংয়ে একটি এন্টারপ্রাইজ ব্লব ফ্রেমওয়ার্ক এবং একটি ব্লব-স্তরের ওয়েব সার্ভার সহ ব্লব ব্যবহার করে লক করেছি । আমার সহকর্মীরা বন্ধুত্বপূর্ণ এবং আমার বস একজন গড় ছোট ব্যবসায়ের মালিক - প্রযুক্তিগত কারণে আমি পুরোপুরি চলে যেতে চাই। …

66 career-development  documentation 

আমি ভাল নথিভুক্ত কোডের গুরুত্ব বুঝতে পারি। তবে আমি স্ব-ডকুমেন্টিং কোডের গুরুত্বও বুঝতে পারি । কোনও নির্দিষ্ট ক্রিয়াকলাপটি দৃশ্যতভাবে পড়া সহজতর, সফ্টওয়্যার রক্ষণাবেক্ষণের সময় আমরা তত দ্রুত এগিয়ে যেতে পারি। এই বলে যে, আমি বড় ফাংশনগুলিকে অন্য ছোটগুলিতে আলাদা করতে চাই । তবে আমি এমন একটি বিন্দুতে যা করি যেখানে …

63 programming-practices  code-quality  documentation 

স্বয়ংক্রিয় ডকুমেন্টেশন জেনারেশন বিভিন্ন সরঞ্জামের সাহায্যে করা যেতে পারে, যা ঘোস্টডক আরও বিশিষ্ট। যাইহোক, সংজ্ঞা অনুসারে, এটি উত্পন্ন সমস্ত কিছুই অপ্রয়োজনীয়। এটি পদ্ধতি, ক্লাস, ইত্যাদির নামগুলির দিকে একবার নজর দেয় এবং ইংরেজী আউটপুট দেয় যা তাদের আরও মৌখিকভাবে ব্যাখ্যা করতে পারে । সর্বোত্তম ক্ষেত্রে, এটি পাঠক ইতিমধ্যে তাদের মাথায় যা …

60 documentation  automation  automatic-programming 

আমি ব্যবহারকারীর ডকুমেন্টেশন (একটি এসওপি) লিখছি যা তৃতীয় পক্ষের প্রোগ্রামগুলির সাথে জড়িত যা আমি ভাল করে বর্ণনা করার চেষ্টা করছি। এরকম একটি প্রোগ্রাম হ'ল একটি সার্ভার যা এটির সূচনার খুব কম ইঙ্গিত দেয় যা গ্রাফিকের পাশাপাশি এটি তার সূচনা / স্টার্টআপ রুটিনের সময় দেখায়। বিকাশকারী হিসাবে, আমি এই উইন্ডোটিকে তাত্ক্ষণিক …

59 documentation  component  jargon 

মাঝে মাঝে আমি নিজেকে পরিস্থিতিতে দেখতে পাই যখন কোডের যে অংশটি আমি লিখছি সে অংশটি (বা মনে হয় ) এতটাই স্বতঃস্পষ্ট যে এর নামটি মূলত একটি মন্তব্য হিসাবে পুনরাবৃত্তি হবে: class Example { /// <summary> /// The location of the update. /// </summary> public Uri UpdateLocation { get; set; }; …

54 programming-practices  documentation  language-agnostic 

আপনি যখন jsdocs এর মতো সরঞ্জামগুলি ব্যবহার করেন , এটি আপনার কোডের মন্তব্যের উপর ভিত্তি করে আপনার কোডবেজে স্থির এইচটিএমএল ফাইল এবং এর স্টাইলগুলি তৈরি করে। এই ফাইলগুলি কি গিট সংগ্রহস্থলে চেক করা উচিত বা তাদের .gitignore দিয়ে উপেক্ষা করা উচিত?

49 git  documentation