Научиться писать документацию и хорошо комментировать код [закрыт]

#документация #javascript #opensource #комментарии

        
             
                
                    
                        
                            Закрыт. На этот вопрос невозможно дать объективный ответ.
Ответы на него в данный момент не принимаются.
                            
                        
                    
                
                            
                                
                
                        
                            
                        
                    
                        
                            Хотите улучшить этот вопрос? Update the question so it
can be answered with facts and citations by editing this post.
                        
                        Закрыт 1 год назад.
                                                                                
           
                
        
Хочу создать свой проект на JavaScript (уже в работе), затем хочу создать для него
(хоть и бесплатный) сайт где можно будет им поинтересоваться скачать и т.д. Может размещу
на code.google (уже занял место). Суть: Мне рано или поздно придётся написать документацию
(объекты,методы входящие в состав). И мой код должен быть доступен для скачивания (opensource)
и соответственно красив. Где можно найти статьи (или стандарты) для написания документации
и статьи про хорошее комментирование кода.    

Ответы

Ответ 1

Документирование кода не может быть "хорошим" - оно может быть правильным и соответствующим
стандартам.
Например один из них и всесторонне поддерживаемый - JSDoc

По поводу "контроля качества кода" - тут немного сложнее. Дело в том что для разных
спецификаций и диалектов языка - разные стандарты.  И то что мы сейчас понимаем под
JavaScript - это не сам язык, а различные скриптоязыки и диалекты из спецификации ECMAScript
и другое - например JSX итд.
Поэтому выбор "стандарта" - зависит от конкретного проекта. Использовать для контроля
можно 'lint' или 'eslint' - пакеты в npm.
А какие плагины и какие настройки к нему использовать - зависит от используемой спецификации
языка, платформы и фреймфорков.