Skip to content

Добавлено хранение информации об аннотации параметров методов.#3420

Merged
nixel2007 merged 2 commits into
developfrom
feature/parameter-annotation
Feb 18, 2025
Merged

Добавлено хранение информации об аннотации параметров методов.#3420
nixel2007 merged 2 commits into
developfrom
feature/parameter-annotation

Conversation

@nixel2007

@nixel2007 nixel2007 commented Feb 17, 2025 •
edited
Loading

Copy link
Copy Markdown
Member

Аннотации выведены в данные о сигнатуре метода в описании.

Описание

Связанные задачи

Closes

Чеклист

Общие

  • Ветка PR обновлена из develop
  • Отладочные, закомментированные и прочие, не имеющие смысла участки кода удалены
  • Изменения покрыты тестами
  • Обязательные действия перед коммитом выполнены (запускал команду gradlew precommit)

Для диагностик

  • Описание диагностики заполнено для обоих языков (присутствуют файлы для обоих языков, для русского заполнено все подробно, перевод на английский можно опустить)

Дополнительно

@nixel2007
Добавлено хранение информации об аннотации параметров методов.
7572ad6 
Аннотации выведены в данные о сигнатуре метода в описании.
@coderabbitai

coderabbitai Bot commented Feb 17, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Walkthrough

В этом изменении дорабатывается обработка аннотаций параметров методов:

  • В MethodSymbolComputer внедрён вызов обработки аннотаций при создании объектов ParameterDefinition.
  • Обновлены классы, связанные с символами методов, для работы с неизменяемыми коллекциями по умолчанию и добавлениям аннотаций.
  • Модифицирован DescriptionFormatter для формирования строковых описаний с учетом аннотаций, а также внесены изменения в тесты и BSL процедуры для проверки новой функциональности.

Changes

Файл(ы) Изменения
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputer.java Добавлен вызов createAnnotations внутри метода createParameters для включения аннотаций в ParameterDefinition.
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/MethodSymbol.java
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/ParameterDefinition.java		 В MethodSymbol изменена инициализация списков (new ArrayList<>() → Collections.emptyList()). В ParameterDefinition добавлено поле annotations и преобразование внутреннего класса DefaultValue в record.
src/main/java/com/github/_1c_syntax/bsl/languageserver/hover/DescriptionFormatter.java Переименован метод getParametersDescriptionPart в getParametersSignatureDescription, добавлен метод getAnnotationsDescriptionPart, изменён метод parameterToString для работы с ParameterDescription.
src/main/java/com/github/_1c_syntax/bsl/languageserver/inlayhints/SourceDefinedMethodCallInlayHintSupplier.java В методе setLabelAndPadding изменён вызов для получения значения по умолчанию с getValue() на value().
src/test/java/com/github/_1c_syntax/bsl/languageserver/context/computer/MethodSymbolComputerTest.java Обновлены проверки: изменено ожидаемое количество методов (24 → 25), поправлены вызовы получения значения по умолчанию, добавлены проверки аннотаций параметров.
src/test/java/com/github/_1c_syntax/bsl/languageserver/hover/DescriptionFormatterTest.java Добавлен новый тестовый класс для проверки включения аннотаций в описание подписей параметров.
src/test/resources/context/computer/MethodSymbolComputerTest.bsl Обновлены определения процедур: в процедуре Метод25 добавлены аннотации, а также добавлена новая процедура Метод24.
src/test/resources/hover/DescriptionFormatter.bsl Добавлена новая экспортируемая процедура МетодСАннотациямиПараметров с параметрами, содержащими аннотации.
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/annotations/Annotation.java Изменена инициализация поля parameters с new ArrayList<>() на Collections.emptyList().

Sequence Diagram(s)

sequenceDiagram
  participant P as BSLParser
  participant MSC as MethodSymbolComputer
  participant PD as ParameterDefinition
  participant DF as DescriptionFormatter

  P->>MSC: Передаёт контекст параметров
  MSC->>PD: Создает ParameterDefinition с аннотациями (createAnnotations)
  PD-->>MSC: Возвращает параметр с аннотациями
  MSC-->>DF: Передает MethodSymbol с параметрами
  DF->>PD: Вызывает getAnnotationsDescriptionPart для каждого параметра
  PD-->>DF: Возвращает описание аннотаций
  DF->>DF: Формирует итоговое описание параметров
Loading

Possibly related PRs

Suggested reviewers

  • theshadowco

Poem

Я кролик-кодер, скачу в новом свете,
Аннотации в параметрах — чудное обновление!
Тесты прошли, код сияет, как звезда в ночи,
Пусть ошибки бегут прочь, исчезая в дали.
🐰 Мой ASCII-код весёл, как прыжок через лужи!
Новый код — как морковный пир, так свеж и радостен!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7572ad6 and 5e44ad9.

📒 Files selected for processing (1)
  • src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/annotations/Annotation.java (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (21)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (23, macOS-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build (23, windows-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (23, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build
  • GitHub Check: build (21, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (21, windows-latest)
  • GitHub Check: build
  • GitHub Check: Analyse
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: build (21, ubuntu-latest)
  • GitHub Check: build (17, macOS-latest)
  • GitHub Check: build (17, windows-latest)
  • GitHub Check: build (17, ubuntu-latest)
  • GitHub Check: Benchmark
🔇 Additional comments (1)
src/main/java/com/github/_1c_syntax/bsl/languageserver/context/symbol/annotations/Annotation.java (1)

27-27: Отличное решение по использованию неизменяемых коллекций!

Переход на Collections.emptyList() вместо new ArrayList<>() - это правильное архитектурное решение, которое:

  • Предотвращает случайные модификации коллекции
  • Более эффективно с точки зрения использования памяти
  • Соответствует принципу неизменяемости

Also applies to: 41-41

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@sonarqubecloud

sonarqubecloud Bot commented Feb 18, 2025

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed

Issues
8 New issues
0 Accepted issues

Measures
0 Security Hotspots
96.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@nixel2007
nixel2007 merged commit ae97c9a into develop Feb 18, 2025
@nixel2007
nixel2007 deleted the feature/parameter-annotation branch February 18, 2025 08:35
@coderabbitai coderabbitai Bot mentioned this pull request Feb 19, 2025
Merged
5 tasks
@coderabbitai coderabbitai Bot mentioned this pull request Oct 27, 2025
Merged
5 tasks
This was referenced May 26, 2026
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@nixel2007